| 1 | n/a | """Base class for index crawlers.""" |
|---|
| 2 | n/a | |
|---|
| 3 | n/a | from packaging.pypi.dist import ReleasesList |
|---|
| 4 | n/a | |
|---|
| 5 | n/a | |
|---|
| 6 | n/a | class BaseClient: |
|---|
| 7 | n/a | """Base class containing common methods for the index crawlers/clients""" |
|---|
| 8 | n/a | |
|---|
| 9 | n/a | def __init__(self, prefer_final, prefer_source): |
|---|
| 10 | n/a | self._prefer_final = prefer_final |
|---|
| 11 | n/a | self._prefer_source = prefer_source |
|---|
| 12 | n/a | self._index = self |
|---|
| 13 | n/a | |
|---|
| 14 | n/a | def _get_prefer_final(self, prefer_final=None): |
|---|
| 15 | n/a | """Return the prefer_final internal parameter or the specified one if |
|---|
| 16 | n/a | provided""" |
|---|
| 17 | n/a | if prefer_final: |
|---|
| 18 | n/a | return prefer_final |
|---|
| 19 | n/a | else: |
|---|
| 20 | n/a | return self._prefer_final |
|---|
| 21 | n/a | |
|---|
| 22 | n/a | def _get_prefer_source(self, prefer_source=None): |
|---|
| 23 | n/a | """Return the prefer_source internal parameter or the specified one if |
|---|
| 24 | n/a | provided""" |
|---|
| 25 | n/a | if prefer_source: |
|---|
| 26 | n/a | return prefer_source |
|---|
| 27 | n/a | else: |
|---|
| 28 | n/a | return self._prefer_source |
|---|
| 29 | n/a | |
|---|
| 30 | n/a | def _get_project(self, project_name): |
|---|
| 31 | n/a | """Return an project instance, create it if necessary""" |
|---|
| 32 | n/a | return self._projects.setdefault(project_name.lower(), |
|---|
| 33 | n/a | ReleasesList(project_name, index=self._index)) |
|---|
| 34 | n/a | |
|---|
| 35 | n/a | def download_distribution(self, requirements, temp_path=None, |
|---|
| 36 | n/a | prefer_source=None, prefer_final=None): |
|---|
| 37 | n/a | """Download a distribution from the last release according to the |
|---|
| 38 | n/a | requirements. |
|---|
| 39 | n/a | |
|---|
| 40 | n/a | If temp_path is provided, download to this path, otherwise, create a |
|---|
| 41 | n/a | temporary location for the download and return it. |
|---|
| 42 | n/a | """ |
|---|
| 43 | n/a | prefer_final = self._get_prefer_final(prefer_final) |
|---|
| 44 | n/a | prefer_source = self._get_prefer_source(prefer_source) |
|---|
| 45 | n/a | release = self.get_release(requirements, prefer_final) |
|---|
| 46 | n/a | if release: |
|---|
| 47 | n/a | dist = release.get_distribution(prefer_source=prefer_source) |
|---|
| 48 | n/a | return dist.download(temp_path) |
|---|
