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 = 
/.*require.*$/

Class Method Summary collapse

Methods included from Analyser

create_analysis, create_error_analysis, included

Class Method Details

.map_dependencies(packages, type) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 99

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 



110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 110

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 



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

def self.mapping
  {
    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_poetry
    },
    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) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 88

def self.parse_conda(file_contents)
  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_pipfile(file_contents) ⇒ Object 



78
79
80
81
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 78

def self.parse_pipfile(file_contents)
  manifest = Tomlrb.parse(file_contents)
  map_dependencies(manifest['packages'], 'runtime') + map_dependencies(manifest['dev-packages'], 'develop')
end

.parse_pipfile_lock(file_contents) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 124

def self.parse_pipfile_lock(file_contents)
  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) ⇒ Object 



83
84
85
86
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 83

def self.parse_poetry(file_contents)
  manifest = Tomlrb.parse(file_contents)['tool']['poetry']
  map_dependencies(manifest['dependencies'], 'runtime') + map_dependencies(manifest['dev-dependencies'], 'develop')
end

.parse_poetry_lock(file_contents) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 141

def self.parse_poetry_lock(file_contents)
  manifest = Tomlrb.parse(file_contents)
  deps = []
  manifest["package"].each do |package|
    # next if group == "_meta"
    group = case package['category']
            when 'main'
              'runtime'
            when 'dev'
              'develop'
            end

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

.parse_requirements_txt(manifest) ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 179

def self.parse_requirements_txt(manifest)
  deps = []
  manifest.split("\n").each do |line|
    match = line.delete(' ').match(REQUIREMENTS_REGEXP)
    next unless match
    deps << {
      name: match[1],
      requirement: match[-1] || '*',
      type: 'runtime'
    }
  end
  deps
end

.parse_setup_py(manifest) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 162

def self.parse_setup_py(manifest)
  match = manifest.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) 


193
194
195
196
197
198
199
200
 
# File 'lib/bibliothecary/parsers/pypi.rb', line 193

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