location

AnyStringLocation

Flexible location representing string with no rules.

__init__(self, max=None) special

Note

If the argument max is None, then any length of string will be accepted.

Parameters:

Name	Type	Description	Default
max	Optional[int]	Max length of string of location.	None

Exceptions:

Type	Description
ValueError	Raised if max is 0 or less.

Source code in bamboo/location.py

def __init__(self, max: t.Optional[int] = None) -> None:
    """
    Note:
        If the argument `max` is `None`, then any length of string
        will be accepted.

    Args:
        max: Max length of string of location.

    Raises:
        ValueError: Raised if `max` is 0 or less.
    """
    if max and max < 1:
        raise ValueError("'max' must be bigger than 0.")

    self._max = max

is_valid(self, loc)

Judge if specified loc is valid location or not.

Parameters:

Name	Type	Description	Default
loc	str	Location to be judged.	required

Returns:

Type	Description
bool	True if specified location is valid, False otherwise.

Source code in bamboo/location.py

def is_valid(self, loc: str) -> bool:
    """Judge if specified `loc` is valid location or not.

    Args:
        loc: Location to be judged.

    Returns:
        True if specified location is valid, False otherwise.
    """
    if self._max is None:
        return True

    len_loc = len(loc)
    if len_loc > self._max or len_loc == 0:
        return False
    return True

AsciiDigitLocation

Flexible location representing location of number in ASCII code.

__init__(self, digits) special

Parameters:

Name	Type	Description	Default
digits	int	Number of digits which the location accepts.	required

Exceptions:

Type	Description
ValueError	Raised if digits is 0 or less.

Source code in bamboo/location.py

def __init__(self, digits: int) -> None:
    """
    Args:
        digits: Number of digits which the location accepts.

    Raises:
        ValueError: Raised if `digits` is 0 or less.
    """
    if digits < 1:
        raise ValueError("'digits' must be bigger than 0.")

    self._digits = digits

is_valid(self, loc)

Judge if specified loc is valid location or not.

Parameters:

Name	Type	Description	Default
loc	str	Location to be judged.	required

Returns:

Type	Description
bool	True if specified location is valid, False otherwise.

Source code in bamboo/location.py

def is_valid(self, loc: str) -> bool:
    """Judge if specified `loc` is valid location or not.

    Args:
        loc: Location to be judged.

    Returns:
        True if specified location is valid, False otherwise.
    """
    return loc.isascii() and loc.isdigit() and len(loc) == self._digits

FlexibleLocation

Base class of flexible location.

Location is concept representing each pieces of path of URI, i.e. locations can configures a path of URI by joining them with separator /.

Location has type of str or subclasses of this class. If a location is str, then the location is called a static location. Otherwise, the location is called a flexible location. Flexible locations means location with some kind of logical rules of strings. The logic of rules can be implemented on is_valid method, returning if specified string is valid in the rules.

is_duplicated_uri(uri_1, uri_2)

Judge if a couple of specified URI patterns has same pattern.

Parameters:

Name	Type	Description	Default
uri_1	Tuple[Union[str, bamboo.location.FlexibleLocation], ...]	URI pattern to be judged	required
uri_2	Tuple[Union[str, bamboo.location.FlexibleLocation], ...]	URI pattern to be judged	required

Returns:

Type	Description
bool	True if two URIs has same pattern, False otherwise.

Source code in bamboo/location.py

def is_duplicated_uri(uri_1: Uri_t, uri_2: Uri_t) -> bool:
    """Judge if a couple of specified URI patterns has same pattern.

    Args:
        uri_1: URI pattern to be judged
        uri_2: URI pattern to be judged

    Returns:
        True if two URIs has same pattern, False otherwise.
    """
    if len(uri_1) == len(uri_2):
        for loc_1, loc_2 in zip(uri_1, uri_2):
            if isinstance(loc_1, FlexibleLocation):
                continue
            if isinstance(loc_2, FlexibleLocation):
                continue

            if loc_1 != loc_2:
                break
        else:
            return True
    return False

is_flexible_uri(uri)

Judge if specified uri has one or more flexible location.

Parameters:

Name	Type	Description	Default
uri	Tuple[Union[str, bamboo.location.FlexibleLocation], ...]	URI pattern to be judged.	required

Returns:

Type	Description
bool	True if specified uri has one or more flexible location, False otherwise.

Source code in bamboo/location.py

def is_flexible_uri(uri: Uri_t) -> bool:
    """Judge if specified `uri` has one or more flexible location.

    Args:
        uri: URI pattern to be judged.

    Returns:
        True if specified `uri` has one or more flexible location,
        False otherwise.
    """
    for loc in uri:
        if isinstance(loc, FlexibleLocation):
            return True
    return False