You've already forked OpenUxAS-bootstrap
mirror of
https://github.com/AdaCore/OpenUxAS-bootstrap.git
synced 2026-02-12 13:07:23 -08:00
8737b1d748
Support pre-commit checks used in AdaCore/e3-core These are a good example of best style practices for python projects. Adding the associated badges to the README (even though it needs to be rewritten) so the commit is complete and consistent. Documentation of how to set up and run the checks is in CONTRIBUTING.md
83 lines
2.0 KiB
Python
83 lines
2.0 KiB
Python
"""Common support for defining and running commands."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
import os
|
|
import subprocess
|
|
|
|
from typing import TYPE_CHECKING
|
|
|
|
if TYPE_CHECKING:
|
|
from typing import List, Optional, Union
|
|
|
|
|
|
class Command:
|
|
"""
|
|
Class to represent a command.
|
|
|
|
A representation of a command, its optional description, and its optional
|
|
working directory.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
cmd: Union[str, List[str]],
|
|
description: Optional[str] = None,
|
|
cwd: Optional[str] = None,
|
|
) -> None:
|
|
self.cmd: List[str] = []
|
|
|
|
# Spurious type errors on both branches:
|
|
if isinstance(cmd, str):
|
|
self.cmd = [cmd]
|
|
else:
|
|
self.cmd = cmd
|
|
|
|
self.description = description
|
|
self.cwd = cwd
|
|
|
|
|
|
def format_command(command: Command) -> str:
|
|
"""Format a command to display in the log."""
|
|
if command.cwd is not None:
|
|
return "(cd {} && {})".format(
|
|
os.path.relpath(command.cwd, os.getcwd()), " ".join(command.cmd)
|
|
)
|
|
else:
|
|
return " ".join(command.cmd)
|
|
|
|
|
|
def log_command(command: Command, dry_run: Optional[bool] = False) -> int:
|
|
"""Log and run a command."""
|
|
if command.description is not None:
|
|
logging.info(command.description)
|
|
|
|
print_cmd = format_command(command)
|
|
logging.debug(print_cmd)
|
|
|
|
if dry_run:
|
|
print(print_cmd)
|
|
return 0
|
|
else:
|
|
return subprocess.run(command.cmd, cwd=command.cwd).returncode
|
|
|
|
|
|
def run_command_and_exit_on_fail(
|
|
command: Command, dry_run: Optional[bool] = False
|
|
) -> None:
|
|
"""
|
|
Log and run a command.
|
|
|
|
Log and run a command, printing a message and exiting if the result is
|
|
nonzero.
|
|
"""
|
|
result = log_command(command, dry_run)
|
|
if result != 0:
|
|
if command.description is not None:
|
|
logging.critical(command.description + " failed.")
|
|
else:
|
|
logging.critical(format_command(command) + " failed.")
|
|
|
|
exit(result)
|