Module: PyPI Private

Extended by:
T::Sig
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

.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:



110
111
112
113
114
115
116
117
118
119
# File 'utils/pypi.rb', line 110

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

  return unless package.valid_pypi_package?

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

.update_python_resources!(formula, version: nil, package_name: nil, extra_packages: nil, exclude_packages: nil, print_only: false, silent: 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)
  • print_only (Boolean, nil) (defaults to: false)
  • silent (Boolean, nil) (defaults to: false)
  • ignore_non_pypi_packages (Boolean, nil) (defaults to: false)

Returns:

  • (Boolean, nil)


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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
# File 'utils/pypi.rb', line 134

def update_python_resources!(formula, version: nil, package_name: nil, extra_packages: nil, exclude_packages: nil,
                             print_only: false, silent: 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"]
    end
  end

  main_package = if package_name.present?
    Package.new(package_name)
  else
    begin
      Package.new(formula.stable.url, is_url: true)
    rescue ArgumentError
      nil
    end
  end

  if main_package.blank?
    return if ignore_non_pypi_packages

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

  unless main_package.valid_pypi_package?
    return if ignore_non_pypi_packages

    odie "\"#{main_package}\" is not available on PyPI."
  end

  main_package.version = version if version.present?

  extra_packages = (extra_packages || []).map { |p| Package.new p }
  exclude_packages = (exclude_packages || []).map { |p| Package.new p }
  exclude_packages += %W[#{main_package.name} argparse pip setuptools wsgiref].map { |p| Package.new p }
  # 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 = [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

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

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

  found_packages = JSON.parse(pipgrip_output).to_h.map do |new_name, new_version|
    Package.new("#{new_name}==#{new_version}")
  end

  new_resource_blocks = ""
  found_packages.sort.each do |package|
    if exclude_packages.include? package
      ohai "Excluding \"#{package}\"" if !print_only && !silent
      next
    end

    ohai "Getting PyPI info for \"#{package}\"" if !print_only && !silent
    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

  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