Module: PyPI Private

Defined in:
utils/pypi.rb

Overview

This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Helper functions for updating PyPI resources.

Defined Under Namespace

Classes: Package

Class Method Summary collapse

Class Method Details

.normalize_python_package(name) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



408
409
410
411
412
 
# File 'utils/pypi.rb', line 408

def self.normalize_python_package(name)
  # This normalization is defined in the PyPA packaging specifications;
  # https://packaging.python.org/en/latest/specifications/name-normalization/#name-normalization
  name.gsub(/[-_.]+/, "-").downcase
end

.pip_report(packages, python_name: "python", print_stderr: false) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'utils/pypi.rb', line 414

def self.pip_report(packages, python_name: "python", print_stderr: false)
  return [] if packages.blank?

  command = [
    Formula[python_name].opt_libexec/"bin/python", "-m", "pip", "install", "-q", "--disable-pip-version-check",
    "--dry-run", "--ignore-installed", "--report=/dev/stdout", *packages.map(&:to_s)
  ]
  options = {}
  options[:err] = :err if print_stderr
  pip_output = Utils.popen_read({ "PIP_REQUIRE_VIRTUALENV" => "false" }, *command, **options)
  unless $CHILD_STATUS.success?
    odie <<~EOS
      Unable to determine dependencies for "#{packages.join(" ")}" because of a failure when running
      `#{command.join(" ")}`.
      Please update the resources manually.
    EOS
  end
  pip_report_to_packages(JSON.parse(pip_output)).uniq
end

.pip_report_to_packages(report) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



434
435
436
437
438
439
440
441
442
443
 
# File 'utils/pypi.rb', line 434

def self.pip_report_to_packages(report)
  return [] if report.blank?

  report["install"].filter_map do |package|
    name = normalize_python_package(package["metadata"]["name"])
    version = package["metadata"]["version"]

    Package.new "#{name}==#{version}"
  end
end

.update_pypi_url(url, version) ⇒ String?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



191
192
193
194
195
196
197
198
199
200
 
# File 'utils/pypi.rb', line 191

def self.update_pypi_url(url, version)
  package = Package.new url, is_url: true

  return unless package.valid_pypi_package?

  _, url = package.pypi_info(new_version: version)
  url
rescue ArgumentError
  nil
end

.update_python_resources!(formula, version: nil, package_name: nil, extra_packages: nil, exclude_packages: nil, dependencies: nil, install_dependencies: false, print_only: false, silent: false, verbose: false, ignore_non_pypi_packages: false) ⇒ Boolean?

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Return true if resources were checked (even if no change).

Parameters:

  • formula (Formula)
  • version (String, nil) (defaults to: nil)
  • package_name (String, nil) (defaults to: nil)
  • extra_packages (Array<String>, nil) (defaults to: nil)
  • exclude_packages (Array<String>, nil) (defaults to: nil)
  • dependencies (Array<String>, nil) (defaults to: nil)
  • install_dependencies (Boolean, nil) (defaults to: false)
  • print_only (Boolean, nil) (defaults to: false)
  • silent (Boolean, nil) (defaults to: false)
  • verbose (Boolean, nil) (defaults to: false)
  • ignore_non_pypi_packages (Boolean, nil) (defaults to: false)

Returns:

  • (Boolean, nil) 


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'utils/pypi.rb', line 218

def self.update_python_resources!(formula, version: nil, package_name: nil, extra_packages: nil,
                                  exclude_packages: nil, dependencies: nil, install_dependencies: false,
                                  print_only: false, silent: false, verbose: false,
                                  ignore_non_pypi_packages: false)

  auto_update_list = formula.tap&.pypi_formula_mappings
  if auto_update_list.present? && auto_update_list.key?(formula.full_name) &&
     package_name.blank? && extra_packages.blank? && exclude_packages.blank?

    list_entry = auto_update_list[formula.full_name]
    case list_entry
    when false
      unless print_only
        odie "The resources for \"#{formula.name}\" need special attention. Please update them manually."
      end
    when String
      package_name = list_entry
    when Hash
      package_name = list_entry["package_name"]
      extra_packages = list_entry["extra_packages"]
      exclude_packages = list_entry["exclude_packages"]
      dependencies = list_entry["dependencies"]
    end
  end

  missing_dependencies = Array(dependencies).reject do |dependency|
    Formula[dependency].any_version_installed?
  rescue FormulaUnavailableError
    odie "Formula \"#{dependency}\" not found but it is a dependency to update \"#{formula.name}\" resources."
  end
  if missing_dependencies.present?
    missing_msg = "formulae required to update \"#{formula.name}\" resources: #{missing_dependencies.join(", ")}"
    odie "Missing #{missing_msg}" unless install_dependencies
    ohai "Installing #{missing_msg}"
    missing_dependencies.each(&method(:ensure_formula_installed!))
  end

  python_deps = formula.deps
                       .select { |d| d.name.match?(/^python(@.+)?$/) }
                       .map(&:to_formula)
                       .sort_by(&:version)
                       .reverse
  python_name = if python_deps.empty?
    "python"
  else
    (python_deps.find(&:any_version_installed?) || python_deps.first).name
  end

  main_package = if package_name.present?
    package_string = package_name
    package_string += "==#{formula.version}" if version.blank? && formula.version.present?
    Package.new(package_string, python_name:)
  elsif package_name == ""
    nil
  else
    stable = T.must(formula.stable)
    url = if stable.specs[:tag].present?
      "git+#{stable.url}@#{stable.specs[:tag]}"
    else
      stable.url
    end
    Package.new(url, is_url: true, python_name:)
  end

  if main_package.nil?
    odie "The main package was skipped but no PyPI `extra_packages` were provided." if extra_packages.blank?
  elsif version.present?
    if main_package.valid_pypi_package?
      main_package.version = version
    else
      return if ignore_non_pypi_packages

      odie "The main package is not a PyPI package, meaning that version-only updates cannot be \
        performed. Please update its URL manually."
    end
  end

  extra_packages = (extra_packages || []).map { |p| Package.new p }
  exclude_packages = (exclude_packages || []).map { |p| Package.new p }
  exclude_packages += %w[argparse pip wsgiref].map { |p| Package.new p }
  if (newest_python = python_deps.first) && newest_python.version < Version.new("3.12")
    exclude_packages.append(Package.new("setuptools"))
  end
  # remove packages from the exclude list if we've explicitly requested them as an extra package
  exclude_packages.delete_if { |package| extra_packages.include?(package) }

  input_packages = Array(main_package)
  extra_packages.each do |extra_package|
    if !extra_package.valid_pypi_package? && !ignore_non_pypi_packages
      odie "\"#{extra_package}\" is not available on PyPI."
    end

    input_packages.each do |existing_package|
      if existing_package.same_package?(extra_package) && existing_package.version != extra_package.version
        odie "Conflicting versions specified for the `#{extra_package.name}` package: " \
             "#{existing_package.version}, #{extra_package.version}"
      end
    end

    input_packages << extra_package unless input_packages.include? extra_package
  end

  formula.resources.each do |resource|
    if !print_only && !resource.url.start_with?(PYTHONHOSTED_URL_PREFIX)
      odie "\"#{formula.name}\" contains non-PyPI resources. Please update the resources manually."
    end
  end

  ensure_formula_installed!(python_name)

  # Resolve the dependency tree of all input packages
  show_info = !print_only && !silent
  ohai "Retrieving PyPI dependencies for \"#{input_packages.join(" ")}\"..." if show_info
  found_packages = pip_report(input_packages, python_name:, print_stderr: verbose && show_info)
  # Resolve the dependency tree of excluded packages to prune the above
  exclude_packages.delete_if { |package| found_packages.exclude? package }
  ohai "Retrieving PyPI dependencies for excluded \"#{exclude_packages.join(" ")}\"..." if show_info
  exclude_packages = pip_report(exclude_packages, python_name:, print_stderr: verbose && show_info)
  exclude_packages += [Package.new(main_package.name)] unless main_package.nil?

  new_resource_blocks = ""
  found_packages.sort.each do |package|
    if exclude_packages.include? package
      ohai "Excluding \"#{package}\"" if show_info
      exclude_packages.delete package
      next
    end

    ohai "Getting PyPI info for \"#{package}\"" if show_info
    name, url, checksum = package.pypi_info
    # Fail if unable to find name, url or checksum for any resource
    if name.blank?
      odie "Unable to resolve some dependencies. Please update the resources for \"#{formula.name}\" manually."
    elsif url.blank? || checksum.blank?
      odie <<~EOS
        Unable to find the URL and/or sha256 for the "#{name}" resource.
        Please update the resources for "#{formula.name}" manually.
      EOS
    end

    # Append indented resource block
    new_resource_blocks += <<-EOS
resource "#{name}" do
  url "#{url}"
  sha256 "#{checksum}"
end

    EOS
  end

  odie "Excluded superfluous packages: #{exclude_packages.join(", ")}" if exclude_packages.any?

  if print_only
    puts new_resource_blocks.chomp
    return
  end

  # Check whether resources already exist (excluding virtualenv dependencies)
  if formula.resources.all? { |resource| resource.name.start_with?("homebrew-") }
    # Place resources above install method
    inreplace_regex = /  def install/
    new_resource_blocks += "  def install"
  else
    # Replace existing resource blocks with new resource blocks
    inreplace_regex = /
      \ \ (
      resource\ .*\ do\s+
        url\ .*\s+
        sha256\ .*\s+
        ((\#.*\s+)*
        patch\ (.*\ )?do\s+
          url\ .*\s+
          sha256\ .*\s+
        end\s+)*
      end\s+)+
    /x
    new_resource_blocks += "  "
  end

  ohai "Updating resource blocks" unless silent
  Utils::Inreplace.inreplace formula.path do |s|
    if T.must(s.inreplace_string.split(/^  test do\b/, 2).first).scan(inreplace_regex).length > 1
      odie "Unable to update resource blocks for \"#{formula.name}\" automatically. Please update them manually."
    end
    s.sub! inreplace_regex, new_resource_blocks
  end

  true
end