Skip to content

Package

Package

Bases: ProfileContainer

The class of omoospace package.

A package class instance is always refer to a existed package directory, not dummy.

Usage: 

pkg = Package('path/to/package')
print(pkg.root_path)
# >>> path/to/package

Attributes:

Name Type Description
name str

Package's name.
description str

Package's description.
version str

Package's version.
Source code in omoospace\package.py 
12
13
14
15
16
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
class Package(ProfileContainer):
    """The class of omoospace package.

    A package class instance is always refer to a existed package directory, not dummy. 

    Usage:
    ```python
    pkg = Package('path/to/package')
    print(pkg.root_path)
    # >>> path/to/package
    ```

    Attributes:
        name (str): Package's name.
        description (str): Package's description.
        version (str): Package's version.
    """
    name: str
    description: str
    version: str

    def __init__(self, package_path: PathLike):
        """Initialize package .

        Args:
            package_path (PathLike): The package path.

        Raises:
            NotFoundError: No package detected.
        """
        package_path = Path(package_path).resolve()
        if (package_path.suffix == ".zip"):
            with ZipFile(package_path, 'r') as zip:
                try:
                    with zip.open('Package.yml') as file:
                        pass
                except:
                    raise NotFoundError("package", package_path)
        else:
            package_info_path = Path(package_path, 'Package.yml')
            if not package_info_path.exists():
                raise NotFoundError("package", package_path)

        self._root_path = package_path
        self._profile_path = Path(self.root_path, "Package.yml").resolve()

    @property
    def root_path(self) -> Path:
        """Path: Root path."""
        return self._root_path

    @property
    def profile_path(self) -> Path:
        """Path: Package.yml file path."""
        return self._profile_path

    def is_package_item(self, path: Path) -> bool:
        """Check if path is package item

        Args:
            path (Path): Input

        Returns:
            bool: result
        """
        exists = path.exists()
        in_package = is_subpath(path, self.root_path)
        not_profile_file = \
            'Omoospace.yml' != path.name \
            and 'Package.yml' != path.name \
            and 'Subspace.yml' not in path.name

        return exists and in_package and not_profile_file

    @property
    def items(self) -> list[Item]:
        """list[Item]: Package item list."""
        items: list[Item] = []
        for root, dirs, files in os.walk(self.root_path):
            for path in files:
                child = Path(root, path).resolve()
                if self.is_package_item(child):
                    items.append(child)
        return items

items: list[Item] property

list[Item]: Package item list.

profile_path: Path property

Path: Package.yml file path.

root_path: Path property

Path: Root path.

__init__(package_path)

Initialize package .

Parameters:

Name Type Description Default
package_path PathLike

The package path.

 required

Raises:

Type Description
NotFoundError

No package detected.
Source code in omoospace\package.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def __init__(self, package_path: PathLike):
    """Initialize package .

    Args:
        package_path (PathLike): The package path.

    Raises:
        NotFoundError: No package detected.
    """
    package_path = Path(package_path).resolve()
    if (package_path.suffix == ".zip"):
        with ZipFile(package_path, 'r') as zip:
            try:
                with zip.open('Package.yml') as file:
                    pass
            except:
                raise NotFoundError("package", package_path)
    else:
        package_info_path = Path(package_path, 'Package.yml')
        if not package_info_path.exists():
            raise NotFoundError("package", package_path)

    self._root_path = package_path
    self._profile_path = Path(self.root_path, "Package.yml").resolve()

is_package_item(path)

Check if path is package item

Parameters:

Name Type Description Default
path Path

Input

 required

Returns:

Name Type Description
bool bool

result
Source code in omoospace\package.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def is_package_item(self, path: Path) -> bool:
    """Check if path is package item

    Args:
        path (Path): Input

    Returns:
        bool: result
    """
    exists = path.exists()
    in_package = is_subpath(path, self.root_path)
    not_profile_file = \
        'Omoospace.yml' != path.name \
        and 'Package.yml' != path.name \
        and 'Subspace.yml' not in path.name

    return exists and in_package and not_profile_file