Skip to content

Site name

Type for the name of a site.

validate_site_name(site_name)

Validate the site name.

The site name must consist of three uppercase letters, optionally followed by a single digit.

Source code in gso/utils/types/site_name.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
def validate_site_name(site_name: str) -> str:
    """Validate the site name.

    The site name must consist of three uppercase letters, optionally followed by a single digit.
    """
    pattern = re.compile(r"^[A-Z]{3}\d?$")
    if not pattern.match(site_name):
        msg = (
            "Enter a valid site name. It must consist of three uppercase letters (A-Z), followed by an optional single "
            f"digit (0-9). Received: {site_name}"
        )
        raise ValueError(msg)
    return site_name