Class: Bibliothecary::Parsers::Pypi

Inherits:
Object
  • Object
show all
Includes:
Analyser
Defined in:
lib/bibliothecary/parsers/pypi.rb

Constant Summary collapse

INSTALL_REGEXP = 
/install_requires\s*=\s*\[([\s\S]*?)\]/
REQUIRE_REGEXP =

Capture Group 1 is package. Optional Group 2 is [extras]. Capture Group 3 is Version

/([a-zA-Z0-9]+[a-zA-Z0-9\-_\.]+)(?:\[.*?\])*([><=\w\.,]+)?/
REQUIREMENTS_REGEXP = 
/^#{REQUIRE_REGEXP}/
MANIFEST_REGEXP = 
/.*require[^\/]*(\/)?[^\/]*\.(txt|pip|in)$/
PIP_COMPILE_REGEXP =

TODO: can this be a more specific regexp so it doesn’t match something like “.yarn/cache/create-require-npm-1.0.0.zip”?

/.*require.*$/
PEP_508_NAME_REGEXP =

Adapted from peps.python.org/pep-0508/#names

/^([A-Z0-9][A-Z0-9._-]*[A-Z0-9]|[A-Z0-9])/i
NoEggSpecified =

While the thing in the repo that PyPI is using might be either in egg format or wheel format, PyPI uses “egg” in the fragment of the VCS URL to specify what package in the PyPI index the VCS URL should be treated as.

Class.new(ArgumentError)

Class Method Summary collapse

Methods included from Analyser

create_analysis, create_error_analysis, included

Class Method Details

.map_dependencies(packages, type) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 143

def self.map_dependencies(packages, type)
  return [] unless packages
  packages.map do |name, info|
    {
      name: name,
      requirement: map_requirements(info),
      type: type,
    }
  end
end

.map_requirements(info) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 154

def self.map_requirements(info)
  if info.is_a?(Hash)
    if info["version"]
      info["version"]
    elsif info["git"]
      info["git"] + "#" + info["ref"]
    else
      "*"
    end
  else
    info || "*"
  end
end

.mapping ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 21

def self.mapping
  {
    match_filenames("requirements-dev.txt", "requirements/dev.txt",
                    "requirements-docs.txt", "requirements/docs.txt",
                    "requirements-test.txt", "requirements/test.txt",
                    "requirements-tools.txt", "requirements/tools.txt") => {
      kind: "manifest",
      parser: :parse_requirements_txt,
    },
    lambda { |p| PIP_COMPILE_REGEXP.match(p) } => {
      content_matcher: :pip_compile?,
      kind: "lockfile",
      parser: :parse_requirements_txt,
    },
    lambda { |p| MANIFEST_REGEXP.match(p) } => {
      kind: "manifest",
      parser: :parse_requirements_txt,
      can_have_lockfile: false,
    },
    match_filename("requirements.frozen") => { # pattern exists to store frozen deps in requirements.frozen
      parser: :parse_requirements_txt,
      kind: "lockfile",
    },
    match_filename("pip-resolved-dependencies.txt") => { # Inferred from pip
      kind: "lockfile",
      parser: :parse_requirements_txt,
    },
    match_filename("setup.py") => {
      kind: "manifest",
      parser: :parse_setup_py,
      can_have_lockfile: false,
    },
    match_filename("Pipfile") => {
      kind: "manifest",
      parser: :parse_pipfile,
    },
    match_filename("Pipfile.lock") => {
      kind: "lockfile",
      parser: :parse_pipfile_lock,
    },
    match_filename("pyproject.toml") => {
      kind: "manifest",
      parser: :parse_pyproject,
    },
    match_filename("poetry.lock") => {
      kind: "lockfile",
      parser: :parse_poetry_lock,
    },
    # Pip dependencies can be embedded in conda environment files
    match_filename("environment.yml") => {
      parser: :parse_conda,
      kind: "manifest",
    },
    match_filename("environment.yaml") => {
      parser: :parse_conda,
      kind: "manifest",
    },
    match_filename("environment.yml.lock") => {
      parser: :parse_conda,
      kind: "lockfile",
    },
    match_filename("environment.yaml.lock") => {
      parser: :parse_conda,
      kind: "lockfile",
    },
  }
end

.parse_conda(file_contents, options: {}) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 132

def self.parse_conda(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
  contents = YAML.safe_load(file_contents)
  return [] unless contents

  dependencies = contents["dependencies"]
  pip = dependencies.find { |dep| dep.is_a?(Hash) && dep["pip"]}
  return [] unless pip

  Pypi.parse_requirements_txt(pip["pip"].join("\n"))
end

.parse_pep_508_dep_spec(dep) ⇒ Object

Simply parses out the name of a PEP 508 Dependency specification: peps.python.org/pep-0508/ Leaves the rest as-is with any leading semicolons or spaces stripped



292
293
294
295
296
297
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 292

def self.parse_pep_508_dep_spec(dep)
  name, requirement = dep.split(PEP_508_NAME_REGEXP, 2).last(2).map(&:strip)
  requirement = requirement.sub(/^[\s;]*/, "")
  requirement = "*" if requirement == ""
  return name, requirement
end

.parse_pipfile(file_contents, options: {}) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



93
94
95
96
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 93

def self.parse_pipfile(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
  manifest = Tomlrb.parse(file_contents)
  map_dependencies(manifest["packages"], "runtime") + map_dependencies(manifest["dev-packages"], "develop")
end

.parse_pipfile_lock(file_contents, options: {}) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 168

def self.parse_pipfile_lock(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
  manifest = JSON.parse(file_contents)
  deps = []
  manifest.each do |group, dependencies|
    next if group == "_meta"
    group = "runtime" if group == "default"
    dependencies.each do |name, info|
      deps << {
        name: name,
        requirement: map_requirements(info),
        type: group,
      }
    end
  end
  deps
end

.parse_poetry(file_contents, options: {}) ⇒ Object

TODO: this was deprecated in 8.6.0. Remove this in any major version bump >= 9.*



127
128
129
130
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 127

def self.parse_poetry(file_contents, options: {})
  puts "Warning: parse_poetry() is deprecated, use parse_pyproject() instead."
  parse_pyproject(file_contents, options)
end

.parse_poetry_lock(file_contents, options: {}) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 185

def self.parse_poetry_lock(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
  manifest = Tomlrb.parse(file_contents)
  deps = []
  manifest["package"].each do |package|
    # next if group == "_meta"
    group = case package["category"]
            when "dev"
              "develop"
            else
              "runtime"
            end

    deps << {
      name: package["name"],
      requirement: map_requirements(package),
      type: group,
    }
  end
  deps
end

.parse_pyproject(file_contents, options: {}) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



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
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 98

def self.parse_pyproject(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
  deps = []

  file_contents = Tomlrb.parse(file_contents)

  # Parse poetry [tool.poetry] deps
  poetry_manifest = file_contents.fetch("tool", {}).fetch("poetry", {})
  deps += map_dependencies(poetry_manifest["dependencies"], "runtime")
  # Poetry 1.0.0-1.2.0 way of defining dev deps
  deps += map_dependencies(poetry_manifest["dev-dependencies"], "develop")
  # Poetry's 1.2.0+ of defining dev deps
  poetry_manifest
    .fetch("group", {})
    .each_pair do |group_name, obj|
      group_name = "develop" if group_name == "dev"
      deps += map_dependencies(obj.fetch("dependencies", {}), group_name)
    end

  # Parse PEP621 [project] deps
  pep621_manifest = file_contents.fetch("project", {})
  pep621_deps = pep621_manifest.fetch("dependencies", []).map { |d| parse_pep_508_dep_spec(d) }
  deps += map_dependencies(pep621_deps, "runtime")

  # We're combining both poetry+PEP621 deps instead of making them mutually exclusive, until we
  # find a reason not to ingest them both.
  deps.uniq
end

.parse_requirements_txt(file_contents, options: {}) ⇒ Object

Parses a requirements.txt file, following the pip.pypa.io/en/stable/cli/pip_install/#requirement-specifiers and pip.pypa.io/en/stable/topics/vcs-support/#git. Invalid lines in requirements.txt are skipped.



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
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 233

def self.parse_requirements_txt(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
  deps = []
  type = case options[:filename]
         when /dev/ || /docs/ || /tools/
           "development"
         when /test/
           "test"
         else
           "runtime"
         end

  file_contents.split("\n").each do |line|
    if line["://"]
      begin
        result = parse_requirements_txt_url(line)
      rescue URI::Error, NoEggSpecified
        next
      end

      deps << result.merge(
        type: type
      )
    else
      match = line.delete(" ").match(REQUIREMENTS_REGEXP)
      next unless match

      deps << {
        name: match[1],
        requirement: match[-1] || "*",
        type: type,
      }
    end
  end
  deps
end

.parse_requirements_txt_url(url) ⇒ Object

Raises:



269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 269

def self.parse_requirements_txt_url(url)
  uri = URI.parse(url)
  raise NoEggSpecified, "No egg specified in #{url}" unless uri.fragment

  name = uri.fragment[/^egg=([^&]+)([&]|$)/, 1]
  raise NoEggSpecified, "No egg specified in #{url}" unless name

  requirement = uri.path[/@(.+)$/, 1]

  { name: name, requirement: requirement || "*" }
end

.parse_setup_py(file_contents, options: {}) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 206

def self.parse_setup_py(file_contents, options: {}) # rubocop:disable Lint/UnusedMethodArgument
  match = file_contents.match(INSTALL_REGEXP)
  return [] unless match
  deps = []
  match[1].gsub(/',(\s)?'/, "\n").split("\n").each do |line|
    next if line.match(/^#/)
    match = line.match(REQUIRE_REGEXP)
    next unless match
    deps << {
      name: match[1],
      requirement: match[-1] || "*",
      type: "runtime",
    }
  end
  deps
end

.pip_compile?(file_contents) ⇒ Boolean

Returns:

  • (Boolean) 


281
282
283
284
285
286
287
288
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 281

def self.pip_compile?(file_contents)
  return file_contents.include?("This file is autogenerated by pip-compile")
rescue Exception # rubocop:disable Lint/RescueException
  # We rescue exception here since native libs can throw a non-StandardError
  # We don't want to throw errors during the matching phase, only during
  # parsing after we match.
  false
end