Skip to main content

Dataclasses

User Guide

There are some dataclasses that serve as configurations in carefree-portable 📦️.

PyRequirement​

Represents a Python requirement for a package or module.

tip

Only one of the four attributes should be specified.

cfport/config.py
@dataclass
class PyRequirement:
    git_url: Optional[str] = None
    package_name: Optional[str] = None
    install_command: Optional[str] = None
    requirement_file: Optional[str] = None

git_url​

[ str, default: None ]

The URL of the Git repository for the requirement.

package_name​

[ str, default: None ]

The name of the package for the requirement.

install_command​

[ str, default: None ]

The custom installation command for the requirement.

requirement_file​

[ str, default: None ]

The path to the requirement file.

Asset​

Represents an asset with optional attributes such as name, URL, path, Git URL, ignores, flatten, and destination.

tip

Only one of url, path, and git_url should be specified.

cfport/config.py
@dataclass
class Asset:
    name: Optional[str] = None
    url: Optional[str] = None
    path: Optional[str] = None
    git_url: Optional[str] = None
    ignores: Optional[List[str]] = None
    flatten: bool = False
    dst: Optional[str] = None

name​

[ str, default: None ]

The name of the asset.

url​

[ str, default: None ]

The URL of the asset.

path​

[ str, default: None ]

The local path of the asset.

git_url​

[ str, default: None ]

The Git URL of the asset.

ignores​

[ List[str], default: None ]

The list of files or directories to ignore during asset fetching.

flatten​

[ bool, default: False ]

Indicates whether to flatten the asset directory structure during copying.

dst​

[ str, default: None ]

The destination path of the asset.

Last updated on