arcanis/ahriman
1
0
Fork 0
mirror of https://github.com/arcan1s/ahriman.git synced 2025-07-15 06:55:48 +00:00
Code Issues Projects Releases Wiki Activity

add notes about documentation and methods inside class

Browse Source 
Because I always forget which way I used before
This commit is contained in:
Evgenii Alekseev
2023-01-03 01:53:10 +02:00
parent 684ef33dbc
commit 666fa98075
15 changed files with 301 additions and 214 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
src/ahriman/application/application/application_packages.py
View File

@ -37,30 +37,6 @@ class ApplicationPackages(ApplicationProperties):
package control class
"""
def _known_packages(self) -> Set[str]:
"""
load packages from repository and pacman repositories
Returns:
Set[str]: list of known packages
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
def on_result(self, result: Result) -> None:
"""
generate report and sync to remote server
Args:
result(Result): build result
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
def _add_archive(self, source: str, *_: Any) -> None:
"""
add package from archive
@ -147,6 +123,18 @@ class ApplicationPackages(ApplicationProperties):
self.database.remote_update(package)
# repository packages must not depend on unknown packages, thus we are not going to process dependencies
def _known_packages(self) -> Set[str]:
"""
load packages from repository and pacman repositories
Returns:
Set[str]: list of known packages
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
def _process_dependencies(self, local_dir: Path, known_packages: Set[str], without_dependencies: bool) -> None:
"""
process package dependencies
@ -178,6 +166,18 @@ class ApplicationPackages(ApplicationProperties):
fn = getattr(self, f"_add_{resolved_source.value}")
fn(name, known_packages, without_dependencies)
def on_result(self, result: Result) -> None:
"""
generate report and sync to remote server
Args:
result(Result): build result
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
def remove(self, names: Iterable[str]) -> None:
"""
remove packages from repository

24
src/ahriman/application/application/application_repository.py
View File

@ -33,18 +33,6 @@ class ApplicationRepository(ApplicationProperties):
repository control class
"""
def on_result(self, result: Result) -> None:
"""
generate report and sync to remote server
Args:
result(Result): build result
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
def clean(self, *, cache: bool, chroot: bool, manual: bool, packages: bool, pacman: bool) -> None:
"""
run all clean methods. Warning: some functions might not be available under non-root
@ -67,6 +55,18 @@ class ApplicationRepository(ApplicationProperties):
if pacman:
self.repository.clear_pacman()
def on_result(self, result: Result) -> None:
"""
generate report and sync to remote server
Args:
result(Result): build result
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
def sign(self, packages: Iterable[str]) -> None:
"""
sign packages and repository

2
src/ahriman/application/handlers/versions.py
View File

@ -61,7 +61,7 @@ class Versions(Handler):
Args:
root(str): root package name
root_extras(Tuple[str, ...]): extras for the root package (Default value = ())
root_extras(Tuple[str, ...], optional): extras for the root package (Default value = ())
Returns:
Dict[str, str]: map of installed dependency to its version

68
src/ahriman/application/lock.py
View File

@ -75,40 +75,6 @@ class Lock(LazyLogging):
self.paths = configuration.repository_paths
self.reporter = Client.load(configuration, report=args.report)
def __enter__(self) -> Lock:
"""
default workflow is the following:
1. Check user UID
2. Check if there is lock file
3. Check web status watcher status
4. Create lock file
5. Report to status page if enabled
"""
self.check_user()
self.check_version()
self.create()
self.reporter.update_self(BuildStatusEnum.Building)
return self
def __exit__(self, exc_type: Optional[Type[Exception]], exc_val: Optional[Exception],
exc_tb: TracebackType) -> Literal[False]:
"""
remove lock file when done
Args:
exc_type(Optional[Type[Exception]]): exception type name if any
exc_val(Optional[Exception]): exception raised if any
exc_tb(TracebackType): exception traceback if any
Returns:
Literal[False]: always False (do not suppress any exception)
"""
self.clear()
status = BuildStatusEnum.Success if exc_val is None else BuildStatusEnum.Failed
self.reporter.update_self(status)
return False
def check_version(self) -> None:
"""
check web server version
@ -145,3 +111,37 @@ class Lock(LazyLogging):
self.path.touch(exist_ok=self.force)
except FileExistsError:
raise DuplicateRunError()
def __enter__(self) -> Lock:
"""
default workflow is the following:
1. Check user UID
2. Check if there is lock file
3. Check web status watcher status
4. Create lock file
5. Report to status page if enabled
"""
self.check_user()
self.check_version()
self.create()
self.reporter.update_self(BuildStatusEnum.Building)
return self
def __exit__(self, exc_type: Optional[Type[Exception]], exc_val: Optional[Exception],
exc_tb: TracebackType) -> Literal[False]:
"""
remove lock file when done
Args:
exc_type(Optional[Type[Exception]]): exception type name if any
exc_val(Optional[Exception]): exception raised if any
exc_tb(TracebackType): exception traceback if any
Returns:
Literal[False]: always False (do not suppress any exception)
"""
self.clear()
status = BuildStatusEnum.Success if exc_val is None else BuildStatusEnum.Failed
self.reporter.update_self(status)
return False

38
src/ahriman/core/alpm/pacman.py
View File

@ -81,25 +81,6 @@ class Pacman(LazyLogging):
return handle
def __getattr__(self, item: str) -> Any:
"""
pacman handle extractor
Args:
item(str): property name
Returns:
Any: attribute by its name
Raises:
AttributeError: in case if no such attribute found
"""
if item == "handle":
handle = self.__create_handle_fn()
setattr(self, item, handle)
return handle
return super().__getattr__(item) # required for logging attribute
def database_copy(self, handle: Handle, database: DB, pacman_root: Path, paths: RepositoryPaths, *,
use_ahriman_cache: bool) -> None:
"""
@ -198,3 +179,22 @@ class Pacman(LazyLogging):
result.update(package.provides) # provides list for meta-packages
return result
def __getattr__(self, item: str) -> Any:
"""
pacman handle extractor
Args:
item(str): property name
Returns:
Any: attribute by its name
Raises:
AttributeError: in case if no such attribute found
"""
if item == "handle":
handle = self.__create_handle_fn()
setattr(self, item, handle)
return handle
return super().__getattr__(item) # required for logging attribute

3
src/ahriman/core/formatters/printer.py
View File

@ -33,8 +33,7 @@ class Printer:
Args:
verbose(bool): print all fields
log_fn(Callable[[str]): logger function to log data
None]: (Default value = print)
log_fn(Callable[[str], None]): logger function to log data (Default value = print)
separator(str, optional): separator for property name and property value (Default value = ": ")
"""
if (title := self.title()) is not None:

38
src/ahriman/core/log/lazy_logging.py
View File

@ -33,25 +33,6 @@ class LazyLogging:
logger: logging.Logger
def __getattr__(self, item: str) -> Any:
"""
logger extractor
Args:
item(str): property name
Returns:
Any: attribute by its name
Raises:
AttributeError: in case if no such attribute found
"""
if item == "logger":
logger = logging.getLogger(self.logger_name)
setattr(self, item, logger)
return logger
raise AttributeError(f"'{self.__class__.__qualname__}' object has no attribute '{item}'")
@property
def logger_name(self) -> str:
"""
@ -107,3 +88,22 @@ class LazyLogging:
yield
finally:
self._package_logger_reset()
def __getattr__(self, item: str) -> Any:
"""
logger extractor
Args:
item(str): property name
Returns:
Any: attribute by its name
Raises:
AttributeError: in case if no such attribute found
"""
if item == "logger":
logger = logging.getLogger(self.logger_name)
setattr(self, item, logger)
return logger
raise AttributeError(f"'{self.__class__.__qualname__}' object has no attribute '{item}'")

24
src/ahriman/core/repository/cleaner.py
View File

@ -30,18 +30,6 @@ class Cleaner(RepositoryProperties):
trait to clean common repository objects
"""
def packages_built(self) -> List[Path]:
"""
get list of files in built packages directory
Returns:
List[Path]: list of filenames from the directory
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError
def clear_cache(self) -> None:
"""
clear cache directory
@ -80,3 +68,15 @@ class Cleaner(RepositoryProperties):
"""
self.logger.info("clear build queue")
self.database.build_queue_clear(None)
def packages_built(self) -> List[Path]:
"""
get list of files in built packages directory
Returns:
List[Path]: list of filenames from the directory
Raises:
NotImplementedError: not implemented method
"""
raise NotImplementedError

16
src/ahriman/core/triggers/trigger_loader.py
View File

@ -75,14 +75,6 @@ class TriggerLoader(LazyLogging):
for trigger in configuration.getlist("build", "triggers")
]
def __del__(self) -> None:
"""
custom destructor object which calls on_stop in case if it was requested
"""
if not self._on_stop_requested:
return
self.on_stop()
@contextlib.contextmanager
def __execute_trigger(self, trigger: Trigger) -> Generator[None, None, None]:
"""
@ -206,3 +198,11 @@ class TriggerLoader(LazyLogging):
for trigger in self.triggers:
with self.__execute_trigger(trigger):
trigger.on_stop()
def __del__(self) -> None:
"""
custom destructor object which calls on_stop in case if it was requested
"""
if not self._on_stop_requested:
return
self.on_stop()