Module: PyPI Private

Defined in:
Library/Homebrew/utils/pypi.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Helper functions for updating PyPI resources.

Class Method Summary collapse

Class Method Details

.get_pypi_info(package, version) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get name, URL and SHA-256 checksum for a given PyPI package.


42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'Library/Homebrew/utils/pypi.rb', line 42

def get_pypi_info(package, version)
  metadata_url = "https://pypi.org/pypi/#{package}/#{version}/json"
  out, _, status = curl_output metadata_url, "--location"

  return unless status.success?

  begin
    json = JSON.parse out
  rescue JSON::ParserError
    return
  end

  sdist = json["urls"].find { |url| url["packagetype"] == "sdist" }
  return json["info"]["name"] if sdist.nil?

  [json["info"]["name"], sdist["url"], sdist["digests"]["sha256"]]
end

.update_pypi_url(url, version) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


33
34
35
36
37
38
39
 
# File 'Library/Homebrew/utils/pypi.rb', line 33

def update_pypi_url(url, version)
  package = url_to_pypi_package_name url
  return if package.nil?

  _, url = get_pypi_info(package, version)
  url
end

.update_python_resources!(formula, version = nil, print_only: false, silent: false, ignore_non_pypi_packages: false) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

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


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'Library/Homebrew/utils/pypi.rb', line 61

def update_python_resources!(formula, version = nil, print_only: false, silent: false,
                             ignore_non_pypi_packages: false)

  if !print_only && AUTOMATIC_RESOURCE_UPDATE_BLOCKLIST.include?(formula.full_name)
    odie "The resources for \"#{formula.name}\" need special attention. Please update them manually."
    return
  end

  pypi_name = url_to_pypi_package_name formula.stable.url

  if pypi_name.nil?
    return if ignore_non_pypi_packages

    odie <<~EOS
      Could not infer PyPI package name from URL:
        #{Formatter.url(formula.stable.url)}
    EOS
  end

  version ||= formula.version

  if get_pypi_info(pypi_name, version).blank?
    odie "\"#{pypi_name}\" at version #{version} is not available on PyPI." unless ignore_non_pypi_packages
    return
  end

  non_pypi_resources = formula.resources.reject do |resource|
    resource.url.start_with? PYTHONHOSTED_URL_PREFIX
  end

  if non_pypi_resources.present? && !print_only
    odie "\"#{formula.name}\" contains non-PyPI resources. Please update the resources manually."
  end

  @pipgrip_installed ||= Formula["pipgrip"].any_version_installed?
  odie '"pipgrip" must be installed (`brew install pipgrip`)' unless @pipgrip_installed

  ohai "Retrieving PyPI dependencies for \"#{pypi_name}==#{version}\"..." if !print_only && !silent
  pipgrip_output = Utils.popen_read Formula["pipgrip"].bin/"pipgrip", "--json", "--no-cache-dir",
                                    "#{pypi_name}==#{version}"
  unless $CHILD_STATUS.success?
    odie <<~EOS
      Unable to determine dependencies for \"#{pypi_name}\" because of a failure when running
      `pipgrip --json --no-cache-dir #{pypi_name}==#{version}`.
      Please update the resources for \"#{formula.name}\" manually.
    EOS
  end

  packages = JSON.parse(pipgrip_output).sort.to_h

  # Remove extra packages that may be included in pipgrip output
  exclude_list = %W[#{pypi_name.downcase} argparse pip setuptools wheel wsgiref]
  packages.delete_if do |package|
    exclude_list.include? package
  end

  new_resource_blocks = ""
  packages.each do |package, package_version|
    ohai "Getting PyPI info for \"#{package}==#{package_version}\"" if !print_only && !silent
    name, url, checksum = get_pypi_info package, package_version
    # 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

  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+ end\s*)+/
    new_resource_blocks += "  "
  end

  ohai "Updating resource blocks" unless silent
  Utils::Inreplace.inreplace formula.path do |s|
    if s.inreplace_string.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

.url_to_pypi_package_name(url) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


27
28
29
30
31
 
# File 'Library/Homebrew/utils/pypi.rb', line 27

def url_to_pypi_package_name(url)
  return unless url.start_with? PYTHONHOSTED_URL_PREFIX

  File.basename(url).match(/^(.+)-[a-z\d.]+$/)[1]
end