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

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
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.freeze
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.freeze

Class Method Summary collapse

Class Method Details

.find_versions(url, regex, cask: nil, &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)

    a regex used for matching versions in content

  • cask (Cask::Cask, nil) (defaults to: nil)
  • block (T.proc.params(arg0: String).returns(T.any(T::Array[String], String)), nil)

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'livecheck/strategy/pypi.rb', line 62

def self.find_versions(url, regex, cask: nil, &block)
  match = File.basename(url).match(FILENAME_REGEX)

  # Use `\.t` instead of specific tarball extensions (e.g. .tar.gz)
  suffix = match[: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/#{match[:package_name].gsub(/%20|_/, "-")}/#files"

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

  PageMatch.find_versions(page_url, regex, cask: cask, &block)
end

.match?(url) ⇒ Boolean

Whether the strategy can be applied to the provided URL.

Parameters:

  • url (String)

    the URL to match against

Returns:

  • (Boolean)


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

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