Class: Homebrew::Livecheck::Strategy::Pypi

Inherits:
Object
  • Object
show all
Defined in:
livecheck/strategy/pypi.rb

Overview

The Pypi strategy identifies versions of software at pypi.org by checking project pages for archive files.

PyPI URLs have a standard format but the hexadecimal text between /packages/ and the filename varies:

  • https://files.pythonhosted.org/packages/<hex>/<hex>/<long_hex>/example-1.2.3.tar.gz

As such, the default regex only targets the filename at the end of the URL.

Constant Summary collapse

NICE_NAME =
"PyPI"
FILENAME_REGEX =

The Regexp used to extract the package name and suffix (e.g. file extension) from the URL basename.

/
  (?<package_name>.+)- # The package name followed by a hyphen
  .*? # The version string
  (?<suffix>\.tar\.[a-z0-9]+|\.[a-z0-9]+)$ # Filename extension
/ix
URL_MATCH_REGEX =

The Regexp used to determine if the strategy applies to the URL.

%r{
  ^https?://files\.pythonhosted\.org
  /packages
  (?:/[^/]+)+ # The hexadecimal paths before the filename
  /#{FILENAME_REGEX.source.strip} # The filename
}ix

Class Method Summary collapse

Class Method Details

.find_versions(url:, regex: nil, **unused, &block) ⇒ Hash{Symbol => T.untyped}

Generates a URL and regex (if one isn’t provided) and passes them to Homebrew::Livecheck::Strategy::PageMatch.find_versions to identify versions in the content.

Parameters:

  • url (String)

    the URL of the content to check

  • regex (Regexp, nil) (defaults to: nil)

    a regex used for matching versions in content

  • unused (T.untyped)
  • block (Proc, nil)

Returns:



91
92
93
94
95
# File 'livecheck/strategy/pypi.rb', line 91

def self.find_versions(url:, regex: nil, **unused, &block)
  generated = generate_input_values(url)

  PageMatch.find_versions(url: generated[:url], regex: regex || generated[:regex], **unused, &block)
end

.generate_input_values(url) ⇒ Hash{Symbol => T.untyped}

Extracts information from a provided URL and uses it to generate various input values used by the strategy to check for new versions. Some of these values act as defaults and can be overridden in a livecheck block.

Parameters:

  • url (String)

    the URL used to generate values

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'livecheck/strategy/pypi.rb', line 55

def self.generate_input_values(url)
  values = {}

  match = File.basename(url).match(FILENAME_REGEX)
  return values if match.blank?

  # It's not technically necessary to have the `#files` fragment at the
  # end of the URL but it makes the debug output a bit more useful.
  values[:url] = "https://pypi.org/project/#{T.must(match[:package_name]).gsub(/%20|_/, "-")}/#files"

  # Use `\.t` instead of specific tarball extensions (e.g. .tar.gz)
  suffix = T.must(match[:suffix]).sub(Strategy::TARBALL_EXTENSION_REGEX, ".t")
  regex_suffix = Regexp.escape(suffix).gsub("\\-", "-")

  # Example regex: `%r{href=.*?/packages.*?/example[._-]v?(\d+(?:\.\d+)*(?:[._-]post\d+)?)\.t}i`
  regex_name = Regexp.escape(T.must(match[:package_name])).gsub("\\-", "-")
  values[:regex] =
    %r{href=.*?/packages.*?/#{regex_name}[._-]v?(\d+(?:\.\d+)*(?:[._-]post\d+)?)#{regex_suffix}}i

  values
end

.match?(url) ⇒ Boolean

Whether the strategy can be applied to the provided URL.

Parameters:

  • url (String)

    the URL to match against

Returns:

  • (Boolean)


43
44
45
# File 'livecheck/strategy/pypi.rb', line 43

def self.match?(url)
  URL_MATCH_REGEX.match?(url)
end