-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #43 from cidrblock/fix_move_collection_out_of_config
Refactor collection, add feedback
- Loading branch information
Showing
13 changed files
with
513 additions
and
286 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| """A collection abstraction.""" | ||
| from __future__ import annotations | ||
|
|
||
| import logging | ||
| import re | ||
| import sys | ||
|
|
||
| from dataclasses import dataclass | ||
| from pathlib import Path | ||
| from typing import TYPE_CHECKING | ||
|
|
||
| import yaml | ||
|
|
||
| from .utils import hint | ||
|
|
||
|
|
||
| if TYPE_CHECKING: | ||
| from .config import Config | ||
|
|
||
|
|
||
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| @dataclass | ||
| class Collection: | ||
| """A collection request specification.""" | ||
|
|
||
| config: Config | ||
| path: Path | None = None | ||
| opt_deps: str | None = None | ||
| local: bool | None = None | ||
| cnamespace: str | None = None | ||
| cname: str | None = None | ||
| specifier: str | None = None | ||
|
|
||
| @property | ||
| def name(self: Collection) -> str: | ||
| """Return the collection name.""" | ||
| return f"{self.cnamespace}.{self.cname}" | ||
|
|
||
| @property | ||
| def cache_dir(self: Collection) -> Path: | ||
| """Return the collection cache directory.""" | ||
| collection_cache_dir = self.config.venv_cache_dir / self.name | ||
| if not collection_cache_dir.exists(): | ||
| collection_cache_dir.mkdir() | ||
| return collection_cache_dir | ||
|
|
||
| @property | ||
| def build_dir(self: Collection) -> Path: | ||
| """Return the collection cache directory.""" | ||
| collection_build_dir = self.cache_dir / "build" | ||
| if not collection_build_dir.exists(): | ||
| collection_build_dir.mkdir() | ||
| return collection_build_dir | ||
|
|
||
| @property | ||
| def site_pkg_path(self: Collection) -> Path: | ||
| """Return the site packages collection path.""" | ||
| if not self.cnamespace or not self.cname: | ||
| msg = "Collection namespace or name not set." | ||
| raise RuntimeError(msg) | ||
| return self.config.site_pkg_collections_path / self.cnamespace / self.cname | ||
|
|
||
|
|
||
| def parse_collection_request( # noqa: PLR0915 | ||
| string: str, | ||
| config: Config, | ||
| ) -> Collection: | ||
| """Parse a collection request str.""" | ||
| collection = Collection(config=config) | ||
| # spec with dep, local | ||
| if "[" in string and "]" in string: | ||
| msg = f"Found optional dependencies in collection request: {string}" | ||
| logger.debug(msg) | ||
| path = Path(string.split("[")[0]).expanduser().resolve() | ||
| if not path.exists(): | ||
| msg = "Provide an existing path to a collection when specifying optional dependencies." | ||
| hint(msg) | ||
| msg = f"Failed to find collection path: {path}" | ||
| logger.critical(msg) | ||
| msg = f"Found local collection request with dependencies: {string}" | ||
| logger.debug(msg) | ||
| collection.path = path | ||
| msg = f"Setting collection path: {collection.path}" | ||
| collection.opt_deps = string.split("[")[1].split("]")[0] | ||
| msg = f"Setting optional dependencies: {collection.opt_deps}" | ||
| logger.debug(msg) | ||
| collection.local = True | ||
| msg = "Setting request as local" | ||
| logger.debug(msg) | ||
| get_galaxy(collection) | ||
| return collection | ||
| # spec without dep, local | ||
| path = Path(string).expanduser().resolve() | ||
| if path.exists(): | ||
| msg = f"Found local collection request without dependencies: {string}" | ||
| logger.debug(msg) | ||
| msg = f"Setting collection path: {path}" | ||
| logger.debug(msg) | ||
| collection.path = path | ||
| msg = "Setting request as local" | ||
| logger.debug(msg) | ||
| collection.local = True | ||
| get_galaxy(collection) | ||
| return collection | ||
| non_local_re = re.compile( | ||
| r""" | ||
| (?P<cnamespace>[A-Za-z0-9]+) # collection name | ||
| \. # dot | ||
| (?P<cname>[A-Za-z0-9]+) # collection name | ||
| (?P<specifier>[^A-Za-z0-9].*)? # optional specifier | ||
| """, | ||
| re.VERBOSE, | ||
| ) | ||
| matched = non_local_re.match(string) | ||
| if not matched: | ||
| msg = ( | ||
| "Specify a valid collection name (ns.n) with an optional version specifier" | ||
| ) | ||
| hint(msg) | ||
| msg = f"Failed to parse collection request: {string}" | ||
| logger.critical(msg) | ||
| sys.exit(1) | ||
| msg = f"Found non-local collection request: {string}" | ||
| logger.debug(msg) | ||
|
|
||
| collection.cnamespace = matched.group("cnamespace") | ||
| msg = f"Setting collection namespace: {collection.cnamespace}" | ||
| logger.debug(msg) | ||
|
|
||
| collection.cname = matched.group("cname") | ||
| msg = f"Setting collection name: {collection.cname}" | ||
| logger.debug(msg) | ||
|
|
||
| if matched.group("specifier"): | ||
| collection.specifier = matched.group("specifier") | ||
| msg = f"Setting collection specifier: {collection.specifier}" | ||
| logger.debug(msg) | ||
|
|
||
| collection.local = False | ||
| msg = "Setting request as non-local" | ||
| logger.debug(msg) | ||
|
|
||
| return collection | ||
|
|
||
|
|
||
| def get_galaxy(collection: Collection) -> None: | ||
| """Retrieve the collection name from the galaxy.yml file. | ||
| Args: | ||
| collection: A collection object | ||
| Raises: | ||
| SystemExit: If the collection name is not found | ||
| """ | ||
| if collection is None or collection.path is None: | ||
| msg = "get_galaxy called without a collection or path" | ||
| raise RuntimeError(msg) | ||
| file_name = collection.path / "galaxy.yml" | ||
| if not file_name.exists(): | ||
| err = f"Failed to find {file_name} in {collection.path}" | ||
| logger.critical(err) | ||
|
|
||
| with file_name.open(encoding="utf-8") as fileh: | ||
| try: | ||
| yaml_file = yaml.safe_load(fileh) | ||
| except yaml.YAMLError as exc: | ||
| err = f"Failed to load yaml file: {exc}" | ||
| logger.critical(err) | ||
|
|
||
| try: | ||
| collection.cnamespace = yaml_file["namespace"] | ||
| collection.cname = yaml_file["name"] | ||
| msg = f"Found collection name: {collection.name} from {file_name}." | ||
| logger.debug(msg) | ||
| except KeyError as exc: | ||
| err = f"Failed to find collection name in {file_name}: {exc}" | ||
| logger.critical(err) | ||
| else: | ||
| return | ||
| raise SystemExit(1) # We shouldn't be here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.