`harbor_cli.config`

Attributes

`DEFAULT_CONFIG_FILE = CONFIG_DIR / 'config.toml'` `module-attribute`

`DEFAULT_HISTORY_FILE = DATA_DIR / 'history'` `module-attribute`

`ENV_VAR_PREFIX = 'HARBOR_CLI_'` `module-attribute`

Classes

`EnvVar`

Bases: StrEnum

Source code in harbor_cli/config.py

class EnvVar(StrEnum):
    CONFIG = env_var("config")
    URL = env_var("url")
    USERNAME = env_var("username")
    SECRET = env_var("secret")
    BASICAUTH = env_var("basicauth")
    CREDENTIALS_FILE = env_var("credentials_file")
    HARBOR_VALIDATE_DATA = env_var("harbor_validate_data")
    HARBOR_RAW_MODE = env_var("harbor_raw_mode")
    HARBOR_VERIFY_SSL = env_var("harbor_verify_ssl")
    HARBOR_RETRY_ENABLED = env_var("harbor_retry_enabled")
    HARBOR_RETRY_MAX_TRIES = env_var("harbor_retry_max_tries")
    HARBOR_RETRY_MAX_TIME = env_var("harbor_retry_max_time")
    TABLE_DESCRIPTION = env_var("table_description")
    TABLE_MAX_DEPTH = env_var("table_max_depth")
    TABLE_COMPACT = env_var("table_compact")
    JSON_INDENT = env_var("json_indent")
    JSON_SORT_KEYS = env_var("json_sort_keys")
    OUTPUT_FORMAT = env_var("output_format")
    PAGING = env_var("paging")
    PAGER = env_var("pager")
    CONFIRM_DELETION = env_var("confirm_deletion")
    CONFIRM_ENUMERATION = env_var("confirm_enumeration")
    WARNINGS = env_var("warnings")

    def __str__(self) -> str:
        return self.value

Attributes

`CONFIG = env_var('config')` `class-attribute` `instance-attribute`

`URL = env_var('url')` `class-attribute` `instance-attribute`

`USERNAME = env_var('username')` `class-attribute` `instance-attribute`

`SECRET = env_var('secret')` `class-attribute` `instance-attribute`

`BASICAUTH = env_var('basicauth')` `class-attribute` `instance-attribute`

`CREDENTIALS_FILE = env_var('credentials_file')` `class-attribute` `instance-attribute`

`HARBOR_VALIDATE_DATA = env_var('harbor_validate_data')` `class-attribute` `instance-attribute`

`HARBOR_RAW_MODE = env_var('harbor_raw_mode')` `class-attribute` `instance-attribute`

`HARBOR_VERIFY_SSL = env_var('harbor_verify_ssl')` `class-attribute` `instance-attribute`

`HARBOR_RETRY_ENABLED = env_var('harbor_retry_enabled')` `class-attribute` `instance-attribute`

`HARBOR_RETRY_MAX_TRIES = env_var('harbor_retry_max_tries')` `class-attribute` `instance-attribute`

`HARBOR_RETRY_MAX_TIME = env_var('harbor_retry_max_time')` `class-attribute` `instance-attribute`

`TABLE_DESCRIPTION = env_var('table_description')` `class-attribute` `instance-attribute`

`TABLE_MAX_DEPTH = env_var('table_max_depth')` `class-attribute` `instance-attribute`

`TABLE_COMPACT = env_var('table_compact')` `class-attribute` `instance-attribute`

`JSON_INDENT = env_var('json_indent')` `class-attribute` `instance-attribute`

`JSON_SORT_KEYS = env_var('json_sort_keys')` `class-attribute` `instance-attribute`

`OUTPUT_FORMAT = env_var('output_format')` `class-attribute` `instance-attribute`

`PAGING = env_var('paging')` `class-attribute` `instance-attribute`

`PAGER = env_var('pager')` `class-attribute` `instance-attribute`

`CONFIRM_DELETION = env_var('confirm_deletion')` `class-attribute` `instance-attribute`

`CONFIRM_ENUMERATION = env_var('confirm_enumeration')` `class-attribute` `instance-attribute`

`WARNINGS = env_var('warnings')` `class-attribute` `instance-attribute`

Functions

`str() -> str`

Source code in harbor_cli/config.py

def __str__(self) -> str:
    return self.value

`BaseModel`

Bases: BaseModel

Base model shared by all config models.

Source code in harbor_cli/config.py

class BaseModel(HarborBaseModel):
    """Base model shared by all config models."""

    # https://pydantic-docs.helpmanual.io/usage/model_config/#change-behaviour-globally

    @model_validator(mode="before")
    @classmethod
    def _pre_root_validator(cls, values: dict[str, Any]) -> dict[str, Any]:
        """Checks for unknown fields and logs a warning if any are found.

        Since we use `extra = "allow"`, it can be useful to check for unknown
        fields and log a warning if any are found, otherwise they will be
        silently ignored.

        See: Config class below.
        """
        for key in values:
            if key not in cls.model_fields:
                logger.warning(
                    "%s: Got unknown config key '%s'.",
                    getattr(cls, "__name__", str(cls)),
                    key,
                )
        return values

    model_config = ConfigDict(extra="allow", validate_assignment=True)

Attributes

`model_config = ConfigDict(extra='allow', validate_assignment=True)` `class-attribute` `instance-attribute`

`HarborCredentialsKwargs`

Bases: TypedDict

Source code in harbor_cli/config.py

class HarborCredentialsKwargs(TypedDict):
    url: str
    username: str
    secret: str
    basicauth: str
    credentials_file: Optional[Path]

Attributes

`url: str` `instance-attribute`

`username: str` `instance-attribute`

`secret: str` `instance-attribute`

`basicauth: str` `instance-attribute`

`credentials_file: Optional[Path]` `instance-attribute`

`RetrySettings`

Bases: BaseModel

Retry settings for API requests.

Source code in harbor_cli/config.py

class RetrySettings(BaseModel):
    """Retry settings for API requests."""

    enabled: bool = True
    max_tries: int = 5
    max_time: float = 10.0

Attributes

`enabled: bool = True` `class-attribute` `instance-attribute`

`max_tries: int = 5` `class-attribute` `instance-attribute`

`max_time: float = 10.0` `class-attribute` `instance-attribute`

`HarborSettings`

Bases: BaseModel

Source code in harbor_cli/config.py

class HarborSettings(BaseModel):
    url: str = ""
    username: str = ""
    secret: SecretStr = SecretStr("")
    basicauth: SecretStr = SecretStr("")
    credentials_file: Optional[Path] = None
    validate_data: bool = Field(default=True, alias="validate")
    raw_mode: bool = False
    verify_ssl: bool = True
    retry: RetrySettings = RetrySettings()
    keyring: bool = False

    @field_validator("credentials_file", mode="before")
    @classmethod
    def _empty_string_is_none(cls, v: Any) -> Any:
        """We can't serialize None to TOML, so we convert it to an empty string.
        However, passing an empty string to Path() will return the current working
        directory, so we need to convert it back to None.
        """
        # I really wish TOML had a None type...
        if v == "":
            return None
        return v

    @field_validator("credentials_file", mode="after")
    @classmethod
    def _validate_credentials_file(cls, v: Path | None) -> Path | None:
        if v is not None:
            if not v.exists():
                raise ValueError(f"Credentials file {v} does not exist")
            elif not v.is_file():
                raise ValueError(f"Credentials file {v} is not a file")
        return v

    @field_serializer("secret", "basicauth")
    def _serialize_secret_str(self, v: SecretStr) -> str:
        return v.get_secret_value()

    @property
    def secret_value(self) -> str:
        """Returns the secret value from the keyring if enabled, otherwise
        returns the secret value from the config file.
        """
        if self.keyring:
            try:
                password = get_password(self.username)
                if password:
                    return password
                warning(
                    f"Keyring is enabled, but no password was found for user {self.username}"
                )
            except KeyringUnsupportedError:
                warning(
                    "Keyring is not supported on this platform. "
                    "Using secret from config file."
                )
                self.keyring = False  # patch it so we don't try again
                return self.secret.get_secret_value()
        return self.secret.get_secret_value()

    @property
    def has_auth_method(self) -> bool:
        """Returns True if any of the auth methods are set."""
        return bool(
            (self.username and self.secret_value)
            or self.basicauth
            or self.credentials_file
        )

    @property
    def credentials(self) -> HarborCredentialsKwargs:
        """Fetches kwargs that can be passed to HarborAsyncClient for
        user authentication.

        Returns
        -------
        HarborCredentialsKwargs
            A dictionary with either base64 credentials, username and password
            or a path to a credentials file.
        """
        return HarborCredentialsKwargs(
            url=self.url,
            username=self.username,
            secret=self.secret_value,
            basicauth=self.basicauth.get_secret_value(),
            credentials_file=self.credentials_file,
        )

    def ensure_authable(self) -> bool:
        """Ensures that the credentials are sufficient to authenticate with the Habror API.
        Raises CredentialsError if not.
        """
        if not self.url:
            raise CredentialsError("A Harbor API URL is required")

        # require one of the auth methods to be set
        if not self.has_auth_method:
            raise CredentialsError(
                "A harbor authentication method must be specified. "
                "One of 'username'+'secret', 'basicauth', or 'credentials_file' must be specified. "
                "See the documentation for more information."
            )
        return True

    def clear_credentials(self) -> None:
        """Clears the credentials from the current configuration."""
        self.username = ""
        self.secret = ""  # type: ignore # pydantic.SecretStr
        self.basicauth = ""  # type: ignore # pydantic.SecretStr
        self.credentials_file = None

    def set_username_secret(self, current_username: str, current_secret: str) -> None:
        username, secret = prompt_username_secret(current_username, current_secret)
        if keyring_supported():
            self._set_username_secret_keyring(username, secret)
        else:
            self._set_username_secret_config(username, secret)

    def _set_username_secret_config(self, username: str, secret: str) -> None:
        """Stores both username and config in config file.
        Insecure fallback in case keyring is not supported.
        """
        self.username = username
        self.secret = secret  # type: ignore # pydantic.SecretStr
        self.keyring = False

    def _set_username_secret_keyring(self, username: str, secret: str) -> None:
        """Set username and secret using keyring.
        Stores the secret in the keyring and the username in the config file.
        """
        self.username = username
        set_password(username, secret)
        self.keyring = True

Attributes

`url: str = ''` `class-attribute` `instance-attribute`

`username: str = ''` `class-attribute` `instance-attribute`

`secret: SecretStr = SecretStr('')` `class-attribute` `instance-attribute`

`basicauth: SecretStr = SecretStr('')` `class-attribute` `instance-attribute`

`credentials_file: Optional[Path] = None` `class-attribute` `instance-attribute`

`validate_data: bool = Field(default=True, alias='validate')` `class-attribute` `instance-attribute`

`raw_mode: bool = False` `class-attribute` `instance-attribute`

`verify_ssl: bool = True` `class-attribute` `instance-attribute`

`retry: RetrySettings = RetrySettings()` `class-attribute` `instance-attribute`

`keyring: bool = False` `class-attribute` `instance-attribute`

`secret_value: str` `property`

Returns the secret value from the keyring if enabled, otherwise returns the secret value from the config file.

`has_auth_method: bool` `property`

Returns True if any of the auth methods are set.

`credentials: HarborCredentialsKwargs` `property`

Fetches kwargs that can be passed to HarborAsyncClient for user authentication.

Returns:

Type	Description
`HarborCredentialsKwargs`	A dictionary with either base64 credentials, username and password or a path to a credentials file.

Functions

`ensure_authable() -> bool`

Ensures that the credentials are sufficient to authenticate with the Habror API. Raises CredentialsError if not.

Source code in harbor_cli/config.py

def ensure_authable(self) -> bool:
    """Ensures that the credentials are sufficient to authenticate with the Habror API.
    Raises CredentialsError if not.
    """
    if not self.url:
        raise CredentialsError("A Harbor API URL is required")

    # require one of the auth methods to be set
    if not self.has_auth_method:
        raise CredentialsError(
            "A harbor authentication method must be specified. "
            "One of 'username'+'secret', 'basicauth', or 'credentials_file' must be specified. "
            "See the documentation for more information."
        )
    return True

`clear_credentials() -> None`

Clears the credentials from the current configuration.

Source code in harbor_cli/config.py

def clear_credentials(self) -> None:
    """Clears the credentials from the current configuration."""
    self.username = ""
    self.secret = ""  # type: ignore # pydantic.SecretStr
    self.basicauth = ""  # type: ignore # pydantic.SecretStr
    self.credentials_file = None

`set_username_secret(current_username: str, current_secret: str) -> None`

Source code in harbor_cli/config.py

def set_username_secret(self, current_username: str, current_secret: str) -> None:
    username, secret = prompt_username_secret(current_username, current_secret)
    if keyring_supported():
        self._set_username_secret_keyring(username, secret)
    else:
        self._set_username_secret_config(username, secret)

`LoggingSettings`

Bases: BaseModel

Source code in harbor_cli/config.py

class LoggingSettings(BaseModel):
    enabled: bool = True
    level: LogLevel = LogLevel.WARNING
    directory: Path = LOGS_DIR
    filename: str = "harbor-cli.log"
    datetime_format: str = Field(
        default="%Y-%m-%d",
        validation_alias=AliasChoices(
            "datetime_format",
            "timeformat",  # Old name (deprecated)
        ),
    )
    retention: int = 30

    @property
    def path(self) -> Path:
        """Full time-formatted path to log file."""
        return self.directory / self.filename.format(
            dt=datetime.now().strftime(self.datetime_format),
            # Deprecated format placeholder:
            time=datetime.now().strftime(self.datetime_format),
        )

Attributes

`enabled: bool = True` `class-attribute` `instance-attribute`

`level: LogLevel = LogLevel.WARNING` `class-attribute` `instance-attribute`

`directory: Path = LOGS_DIR` `class-attribute` `instance-attribute`

`filename: str = 'harbor-cli.log'` `class-attribute` `instance-attribute`

`datetime_format: str = Field(default='%Y-%m-%d', validation_alias=AliasChoices('datetime_format', 'timeformat'))` `class-attribute` `instance-attribute`

`retention: int = 30` `class-attribute` `instance-attribute`

`path: Path` `property`

Full time-formatted path to log file.

`TableStyleSettings`

Bases: BaseModel

Source code in harbor_cli/config.py

class TableStyleSettings(BaseModel):
    title: Optional[str] = None
    header: Optional[str] = STYLE_TABLE_HEADER
    rows: Optional[Tuple[str, str]] = None
    border: Optional[str] = None
    footer: Optional[str] = None
    caption: Optional[str] = None
    expand: bool = True
    show_header: bool = True
    bool_emoji: bool = False
    # TODO: box

    @field_validator("rows", mode="before")
    @classmethod
    def _validate_rows(cls, v: Any) -> Optional[Tuple[str, ...]]:
        """Validates the rows field.

        Strings are turned into tuples of length 2 where both elements
        are the string value. e.g. "black" becomes ("black", "black").

        Sequences are truncated to length 2. If the sequence is length 1,
        the first element is repeated. e.g. ("black",) becomes ("black", "black"),
        and ("black", "white", "red") becomes ("black", "white").

        None, empty strings, and empty sequences are converted to None.
        """
        # TODO: refactor this to separate function so it can be used by other
        # validators, and so that we can have one central set of tests,
        # that covers all validators using the function.

        if not v:  # catches None, "", and empty sequence
            return None
        if isinstance(v, str):
            return (v, v)
        if not isinstance(v, Sequence):
            raise TypeError("TableStyleSettings.rows must be a sequence.")
        else:
            v = cast(Sequence[Any], v)
        vv = tuple(v)

        # If all elements are None or empty, return None
        if all(not x for x in vv):
            return None

        # vv is guaranteed to be a non-empty tuple at this point
        if len(vv) > 2:
            vv = vv[:2]
        elif len(vv) == 1:
            vv = (vv[0], v[0])
        return vv

    # TODO add * validator that turns empty strings into None?
    @field_validator("*")
    @classmethod
    def _empty_string_is_none(cls, v: Any) -> Any:
        """TOML has no None support, but we need to pass these kwargs to
        Rich's Table constructor, which does uses None. So we convert
        empty strings to None.
        """
        if v == "":
            return None
        return v

    def as_rich_kwargs(self) -> RichTableKwargs:
        """Converts the TableStyleSettings to a dictionary that can be passed
        to Rich's Table constructor.

        Returns
        -------
        RichTableKwargs
            A dictionary of Rich Table style settings.
        """
        return {
            "border_style": self.border,
            "caption_style": self.caption,
            "expand": self.expand,
            "footer_style": self.footer,
            "header_style": self.header,
            "row_styles": self.rows,
            "show_header": self.show_header,
            "title_style": self.title,
        }

Attributes

`title: Optional[str] = None` `class-attribute` `instance-attribute`

`header: Optional[str] = STYLE_TABLE_HEADER` `class-attribute` `instance-attribute`

`rows: Optional[Tuple[str, str]] = None` `class-attribute` `instance-attribute`

`border: Optional[str] = None` `class-attribute` `instance-attribute`

`footer: Optional[str] = None` `class-attribute` `instance-attribute`

`caption: Optional[str] = None` `class-attribute` `instance-attribute`

`expand: bool = True` `class-attribute` `instance-attribute`

`show_header: bool = True` `class-attribute` `instance-attribute`

`bool_emoji: bool = False` `class-attribute` `instance-attribute`

Functions

`as_rich_kwargs() -> RichTableKwargs`

Converts the TableStyleSettings to a dictionary that can be passed to Rich's Table constructor.

Returns:

Type	Description
`RichTableKwargs`	A dictionary of Rich Table style settings.

Source code in harbor_cli/config.py

def as_rich_kwargs(self) -> RichTableKwargs:
    """Converts the TableStyleSettings to a dictionary that can be passed
    to Rich's Table constructor.

    Returns
    -------
    RichTableKwargs
        A dictionary of Rich Table style settings.
    """
    return {
        "border_style": self.border,
        "caption_style": self.caption,
        "expand": self.expand,
        "footer_style": self.footer,
        "header_style": self.header,
        "row_styles": self.rows,
        "show_header": self.show_header,
        "title_style": self.title,
    }

`TableSettings`

Bases: BaseModel

Settings for the table output format.

Source code in harbor_cli/config.py

class TableSettings(BaseModel):
    """Settings for the table output format."""

    description: bool = False
    max_depth: int = 0
    compact: bool = True
    style: TableStyleSettings = TableStyleSettings()
    # max_width: Optional[int] = None
    # max_lines: Optional[int] = None

    @field_validator("max_depth", mode="before")
    @classmethod
    def check_max_depth(cls, v: Any) -> Any:
        """Converts max_depth to an integer, and checks that it is not negative."""
        if v is None:
            return 0
        try:
            v = int(v)
        except ValueError:
            raise ValueError("max_depth must be an integer")
        # We used to accept negative integers, and to avoid breaking
        # existing configs immediately, we just check if the value is negative,
        # and if so, return 0.
        # In the future, we will use Field(..., ge=0) to enforce it.
        if v < 0:
            warning(
                "max_depth will stop accepting negative values in a future version. Use 0 instead."
            )
            return 0
        return v

Attributes

`description: bool = False` `class-attribute` `instance-attribute`

`max_depth: int = 0` `class-attribute` `instance-attribute`

`compact: bool = True` `class-attribute` `instance-attribute`

`style: TableStyleSettings = TableStyleSettings()` `class-attribute` `instance-attribute`

Functions

`check_max_depth(v: Any) -> Any` `classmethod`

Converts max_depth to an integer, and checks that it is not negative.

Source code in harbor_cli/config.py

@field_validator("max_depth", mode="before")
@classmethod
def check_max_depth(cls, v: Any) -> Any:
    """Converts max_depth to an integer, and checks that it is not negative."""
    if v is None:
        return 0
    try:
        v = int(v)
    except ValueError:
        raise ValueError("max_depth must be an integer")
    # We used to accept negative integers, and to avoid breaking
    # existing configs immediately, we just check if the value is negative,
    # and if so, return 0.
    # In the future, we will use Field(..., ge=0) to enforce it.
    if v < 0:
        warning(
            "max_depth will stop accepting negative values in a future version. Use 0 instead."
        )
        return 0
    return v

`JSONSettings`

Bases: BaseModel

Source code in harbor_cli/config.py

class JSONSettings(BaseModel):
    indent: int = 2
    sort_keys: bool = False

Attributes

`indent: int = 2` `class-attribute` `instance-attribute`

`sort_keys: bool = False` `class-attribute` `instance-attribute`

`OutputSettings`

Bases: BaseModel

Source code in harbor_cli/config.py

class OutputSettings(BaseModel):
    format: OutputFormat = OutputFormat.TABLE
    paging: bool = Field(
        default=False,
        description="Show output in pager (if supported). Default pager does not support color output currently.",
    )
    pager: str = Field(default="", description="Pager to use if paging is enabled.")
    # Naming: Don't shadow the built-in .json() method
    # The config file can still use the key "json" because of the alias
    table: TableSettings = Field(default_factory=TableSettings)
    JSON: JSONSettings = Field(default_factory=JSONSettings, alias="json")

    @field_validator("pager")
    @classmethod
    def set_pager(cls, v: Optional[str]) -> Optional[str]:
        """Validator that sets the MANPAGER environment variable if a pager is set.
        https://rich.readthedocs.io/en/stable/console.html#paging
        """
        if not v:
            return v
        os.environ["MANPAGER"] = v
        os.environ["PAGER"] = v
        return v

    model_config = ConfigDict(populate_by_name=True)

Attributes

`format: OutputFormat = OutputFormat.TABLE` `class-attribute` `instance-attribute`

`paging: bool = Field(default=False, description='Show output in pager (if supported). Default pager does not support color output currently.')` `class-attribute` `instance-attribute`

`pager: str = Field(default='', description='Pager to use if paging is enabled.')` `class-attribute` `instance-attribute`

`table: TableSettings = Field(default_factory=TableSettings)` `class-attribute` `instance-attribute`

`JSON: JSONSettings = Field(default_factory=JSONSettings, alias='json')` `class-attribute` `instance-attribute`

`model_config = ConfigDict(populate_by_name=True)` `class-attribute` `instance-attribute`

Functions

`set_pager(v: Optional[str]) -> Optional[str]` `classmethod`

Validator that sets the MANPAGER environment variable if a pager is set. https://rich.readthedocs.io/en/stable/console.html#paging

Source code in harbor_cli/config.py

@field_validator("pager")
@classmethod
def set_pager(cls, v: Optional[str]) -> Optional[str]:
    """Validator that sets the MANPAGER environment variable if a pager is set.
    https://rich.readthedocs.io/en/stable/console.html#paging
    """
    if not v:
        return v
    os.environ["MANPAGER"] = v
    os.environ["PAGER"] = v
    return v

`GeneralSettings`

Bases: BaseModel

General settings for Harbor CLI.

Source code in harbor_cli/config.py

class GeneralSettings(BaseModel):
    """General settings for Harbor CLI."""

    confirm_deletion: bool = Field(
        default=True,
        description=(
            "Show confirmation prompt for resource deletion "
            "commands. E.g. `project delete`"
        ),
    )
    confirm_enumeration: bool = Field(
        default=True,
        description=(
            "Show confirmation prompt for certain resource enumeration "
            "commands when invoked without a limit or filter. E.g. `auditlog list`"
        ),
    )
    warnings: bool = Field(
        default=True,
        description="Show warning messages in terminal. Warnings are always logged regardless of this option.",
    )

Attributes

confirm_deletion: bool = Field(default=True, description='Show confirmation prompt for resource deletion commands. E.g. `project delete`') `class-attribute` `instance-attribute`

confirm_enumeration: bool = Field(default=True, description='Show confirmation prompt for certain resource enumeration commands when invoked without a limit or filter. E.g. `auditlog list`') `class-attribute` `instance-attribute`

`warnings: bool = Field(default=True, description='Show warning messages in terminal. Warnings are always logged regardless of this option.')` `class-attribute` `instance-attribute`

`REPLSettings`

Bases: BaseModel

Source code in harbor_cli/config.py

class REPLSettings(BaseModel):
    history: bool = Field(
        default=True, description="Enable persistent history in the REPL."
    )
    history_file: Path = Field(
        default=DEFAULT_HISTORY_FILE,
        description="Path to custom location of history file.",
    )

    @model_validator(mode="after")
    def _create_history_file_if_not_exists(self) -> Self:
        if not self.history:
            return self
        if not self.history_file.exists():
            self.history_file.parent.mkdir(parents=True, exist_ok=True)
            self.history_file.touch()
        return self

Attributes

`history: bool = Field(default=True, description='Enable persistent history in the REPL.')` `class-attribute` `instance-attribute`

`history_file: Path = Field(default=DEFAULT_HISTORY_FILE, description='Path to custom location of history file.')` `class-attribute` `instance-attribute`

`CacheSettings`

Bases: BaseModel

DEPRECATED: Caching was removed in 0.2.0. This class is left here for compatibility.

Source code in harbor_cli/config.py

class CacheSettings(BaseModel):
    """DEPRECATED: Caching was removed in 0.2.0. This class is left here for compatibility."""

    enabled: bool = Field(
        default=False,
        description="Enable in-memory caching of API responses. This can significantly speed up Harbor CLI, but should be considered experimental for now.",
    )
    ttl: int = Field(
        default=300,
        description="Time to live for cached responses, in seconds.",
    )

Attributes

`enabled: bool = Field(default=False, description='Enable in-memory caching of API responses. This can significantly speed up Harbor CLI, but should be considered experimental for now.')` `class-attribute` `instance-attribute`

`ttl: int = Field(default=300, description='Time to live for cached responses, in seconds.')` `class-attribute` `instance-attribute`