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

Inherits:
Object
  • Object
show all
Defined in:
brew/Library/Homebrew/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"
URL_MATCH_REGEX =

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

/files\.pythonhosted\.org/i.freeze

Class Method Summary collapse

Class Method Details

.find_versions(url, regex = nil) ⇒ Hash

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

Parameters:

  • url (String)

    the URL of the content to check

  • regex (Regexp) (defaults to: nil)

    a regex used for matching versions in content

Returns:

  • (Hash)


36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# File 'brew/Library/Homebrew/livecheck/strategy/pypi.rb', line 36

def self.find_versions(url, regex = nil)
  /
    (?<package_name>.+)- # The package name followed by a hyphen
    .*? # The version string
    (?<suffix>\.tar\.[a-z0-9]+|\.[a-z0-9]+)$ # Filename extension
  /ix =~ File.basename(url)

  # Use `\.t` instead of specific tarball extensions (e.g., .tar.gz)
  suffix.sub!(/\.t(?:ar\..+|[a-z0-9]+)$/i, "\.t")

  # 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.
  page_url = "https://pypi.org/project/#{package_name.gsub(/%20|_/, "-")}#files"

  # Example regex: `%r{href=.*?/packages.*?/example[._-]v?(\d+(?:\.\d+)*).t}i`.
  regex ||=
    %r{href=.*?/packages.*?/#{Regexp.escape(package_name)}[._-]v?(\d+(?:\.\d+)*)#{Regexp.escape(suffix)}}i

  Homebrew::Livecheck::Strategy::PageMatch.find_versions(page_url, regex)
end

.match?(url) ⇒ Boolean

Whether the strategy can be applied to the provided URL.

Parameters:

  • url (String)

    the URL to match against

Returns:

  • (Boolean)


26
27
28
# File 'brew/Library/Homebrew/livecheck/strategy/pypi.rb', line 26

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