"""Local representations of API objects."""
import dataclasses
import pathlib
from typing import Optional, List, TypeVar
from repobee_plug import exceptions
from repobee_plug import _featflags
MAX_NAME_LENGTH = 100
__all__ = ["StudentTeam", "StudentRepo", "TemplateRepo"]
def _check_name_length(name):
"""Check that a Team/Repository name does not exceed the maximum GitHub
allows (100 characters)
"""
if len(name) > MAX_NAME_LENGTH:
raise ValueError(
f"generated Team/Repository name is too long, was {len(name)} chars, "
f"max is {MAX_NAME_LENGTH} chars"
)
[docs]
@dataclasses.dataclass(frozen=True, order=True)
class StudentTeam:
"""Local representation of a student team.
Attributes:
members: A list of members of this team.
name: The name of this team.
"""
members: List[str] = dataclasses.field(compare=False)
name: str = dataclasses.field(default="", compare=True)
def __str__(self):
return self.name
def __post_init__(self):
object.__setattr__(
self, "members", [normalize_name(m) for m in self.members]
)
object.__setattr__(
self, "name", self.name or "-".join(sorted(self.members))
)
_check_name_length(self.name)
Pathed = TypeVar("Pathed", bound="_RepoPathMixin")
class _RepoPathMixin:
"""Mixin class for local repo representations that provides a path
attribute, which may not be set.
"""
_path: Optional[pathlib.Path]
def __init__(self, *args, **kwargs):
pass
def with_path(self: Pathed, path: pathlib.Path) -> Pathed:
"""Return a copy of this repo, with a different path.
Args:
path: Path to the local copy of this repo.
Returns:
A copy of this repo representation, with the specified path.
"""
return dataclasses.replace(self, _path=path) # type: ignore
@property
def path(self) -> pathlib.Path:
if not self._path:
raise exceptions.PlugError("path not set")
return self._path
[docs]
@dataclasses.dataclass(frozen=True)
class StudentRepo(_RepoPathMixin):
"""Local representation of a student repo.
Attributes:
name: Name of this repository.
team: The team this repository belongs to.
url: URL to the platform repository.
path: Path to the local copy of this repository.
"""
name: str
team: StudentTeam
url: str
_path: Optional[pathlib.Path] = None
def __post_init__(self):
_check_name_length(self.name)
[docs]
@dataclasses.dataclass(frozen=True)
class TemplateRepo(_RepoPathMixin):
"""Local representation of a template repo.
Attributes:
name: Name of this repository.
url: URL to the platform repository.
path: Path to the local copy of this repository.
file_uri: File URI to the local copy of this repository.
"""
name: str
url: str
_path: Optional[pathlib.Path] = None
@property
def file_uri(self):
p = f"file://{self.path}"
print(p)
return f"file://{self.path}"
def normalize_name(name: str) -> str:
"""Normalize a name (e.g. repo or username) according to RepoBee's conventions.
Name normalization can be disabled by setting the
REPOBEE_DISABLE_NAME_NORMALIZATION environment variable to true for better
interoperability with external tools such as GitHub Classroom.
Args:
name: A name.
Returns:
A normalized representation of the name.
"""
if _featflags.is_feature_enabled(
_featflags.FeatureFlag.REPOBEE_DISABLE_NAME_NORMALIZATION
):
return name
return name.casefold()