Skip to content

Commit

Permalink
ci(pre-commit.ci): 🎨 Auto format from pre-commit.com hooks
Browse files Browse the repository at this point in the history
  • Loading branch information
pre-commit-ci[bot] committed Nov 4, 2024
1 parent d6ecf69 commit ddae689
Show file tree
Hide file tree
Showing 16 changed files with 46 additions and 73 deletions.
2 changes: 1 addition & 1 deletion micropy/app/stubs.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ def _get_desc(name: str, cfg: dict):
pyb.run_script(create_stubs, DevicePath(dev_path))
except Exception as e:
# TODO: Handle more usage cases
log.error(f"Failed to execute script: {str(e)}", exception=e)
log.error(f"Failed to execute script: {e!s}", exception=e)
raise
log.success("Done!")
log.info("Copying stubs...")
Expand Down
3 changes: 2 additions & 1 deletion micropy/exceptions.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Micropy Exceptions."""

from __future__ import annotations


Expand All @@ -21,7 +22,7 @@ class StubValidationError(StubError):
"""Raised when a stub fails validation."""

def __init__(self, path, errors, *args, **kwargs):
msg = f"Stub at[{str(path)}] encountered" f" the following validation errors: {str(errors)}"
msg = f"Stub at[{path!s}] encountered" f" the following validation errors: {errors!s}"
super().__init__(msg, *args, **kwargs)

def __str__(self):
Expand Down
2 changes: 1 addition & 1 deletion micropy/logger.py
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ def exception(self, error, **kwargs):
"""
name = type(error).__name__
msg = f"{name}: {str(error)}"
msg = f"{name}: {error!s}"
return self.echo(msg, log="exception", title_color="red", fg="red", accent="red", **kwargs)

def success(self, msg, **kwargs):
Expand Down
1 change: 0 additions & 1 deletion micropy/project/modules/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""Project Modules."""


from .modules import HookProxy, ProjectModule
from .packages import DevPackagesModule, PackagesModule
from .stubs import StubsModule
Expand Down
1 change: 0 additions & 1 deletion micropy/project/modules/templates.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""Project Templates Module."""


from micropy.project.modules import ProjectModule
from micropy.project.template import TemplateProvider

Expand Down
8 changes: 4 additions & 4 deletions micropy/project/template.py
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ def render_to(self, name, parent_dir, *args, **kwargs):
"""
template = self.get(name, **kwargs)
self.log.debug(f"Loaded: {str(template)}")
self.log.debug(f"Loaded: {template!s}")
if self.run_checks:
self.log.debug(f"Verifying {template} requirements...")
template.run_checks()
Expand All @@ -305,7 +305,7 @@ def render_to(self, name, parent_dir, *args, **kwargs):
self.log.debug(f"Create: {out_dir}")
parent_dir.mkdir(exist_ok=True)
out_dir.parent.mkdir(exist_ok=True, parents=True)
self.log.debug(f"Rendered: {name} to {str(out_dir)}")
self.log.debug(f"Rendered: {name} to {out_dir!s}")
self.log.info(f"$[{name.capitalize()}] File Generated!")
stream = template.render_stream()
return stream.dump(str(out_dir))
Expand All @@ -326,13 +326,13 @@ def update(self, name, root_dir, **kwargs):
"""
template = self.get(name, **kwargs)
self.log.debug(f"Loaded: {str(template)}")
self.log.debug(f"Loaded: {template!s}")
try:
template.update(root_dir)
except FileNotFoundError:
self.log.debug("Template does not exist!")
return self.render_to(name, root_dir, **kwargs)
self.log.debug(f"Updated: {str(template)}")
self.log.debug(f"Updated: {template!s}")
return template

@property
Expand Down
84 changes: 28 additions & 56 deletions micropy/pyd/abc.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,80 +10,65 @@


class StartHandler(Protocol):
def __call__(self, *, name: str = None, size: int | None = None) -> Any:
...
def __call__(self, *, name: str = None, size: int | None = None) -> Any: ...


class UpdateHandler(Protocol):
def __call__(self, *, size: int | None = None) -> Any:
...
def __call__(self, *, size: int | None = None) -> Any: ...


class EndHandler(Protocol):
def __call__(self) -> Any:
...
def __call__(self) -> Any: ...


class MessageHandler(Protocol):
def __call__(self, data: AnyStr) -> Any:
...
def __call__(self, data: AnyStr) -> Any: ...


class StreamConsumer(Protocol):
@property
@abc.abstractmethod
def on_start(self) -> StartHandler:
...
def on_start(self) -> StartHandler: ...

@property
@abc.abstractmethod
def on_update(self) -> UpdateHandler:
...
def on_update(self) -> UpdateHandler: ...

@property
@abc.abstractmethod
def on_end(self) -> EndHandler:
...
def on_end(self) -> EndHandler: ...


class MessageConsumer(Protocol):
@property
@abc.abstractmethod
def on_message(self) -> MessageHandler:
...
def on_message(self) -> MessageHandler: ...


class PyDeviceConsumer(MessageConsumer, StreamConsumer, Protocol):
...
class PyDeviceConsumer(MessageConsumer, StreamConsumer, Protocol): ...


class MetaPyDeviceBackend(abc.ABC):
location: str

@abc.abstractmethod
def establish(self, target: str) -> MetaPyDeviceBackend:
...
def establish(self, target: str) -> MetaPyDeviceBackend: ...

@abc.abstractmethod
def connect(self) -> None:
...
def connect(self) -> None: ...

@abc.abstractmethod
def disconnect(self) -> None:
...
def disconnect(self) -> None: ...

@abc.abstractmethod
def reset(self) -> None:
...
def reset(self) -> None: ...

@abc.abstractmethod
def resolve_path(self, target_path: DevicePath | str | Path) -> DevicePath:
...
def resolve_path(self, target_path: DevicePath | str | Path) -> DevicePath: ...

@property
@abc.abstractmethod
def connected(self) -> bool:
...
def connected(self) -> bool: ...

@abc.abstractmethod
def push_file(
Expand All @@ -93,8 +78,7 @@ def push_file(
*,
consumer: PyDeviceConsumer | None,
**kwargs,
) -> None:
...
) -> None: ...

@abc.abstractmethod
def pull_file(
Expand All @@ -104,16 +88,13 @@ def pull_file(
*,
consumer: PyDeviceConsumer | None,
**kwargs,
) -> None:
...
) -> None: ...

@abc.abstractmethod
def list_dir(self, path: DevicePath) -> list[DevicePath]:
...
def list_dir(self, path: DevicePath) -> list[DevicePath]: ...

@abc.abstractmethod
def remove(self, path: DevicePath) -> None:
...
def remove(self, path: DevicePath) -> None: ...

@abc.abstractmethod
def copy_dir(
Expand All @@ -123,12 +104,10 @@ def copy_dir(
*,
consumer: PyDeviceConsumer | None,
**kwargs,
):
...
): ...

@abc.abstractmethod
def eval(self, command: str, *, consumer: MessageConsumer | None = None):
...
def eval(self, command: str, *, consumer: MessageConsumer | None = None): ...

@abc.abstractmethod
def eval_script(
Expand All @@ -137,8 +116,7 @@ def eval_script(
target_path: DevicePath | None = None,
*,
consumer: PyDeviceConsumer | None = None,
):
...
): ...


AnyBackend = TypeVar("AnyBackend", bound=MetaPyDeviceBackend)
Expand All @@ -150,29 +128,23 @@ class MetaPyDevice(abc.ABC, Generic[AnyBackend]):
message_consumer: MessageConsumer | None

@abc.abstractmethod
def connect(self) -> None:
...
def connect(self) -> None: ...

@abc.abstractmethod
def disconnect(self) -> None:
...
def disconnect(self) -> None: ...

@abc.abstractmethod
def copy_to(self, source_path: HostPath, target_path: DevicePath) -> None:
...
def copy_to(self, source_path: HostPath, target_path: DevicePath) -> None: ...

@abc.abstractmethod
def copy_from(
self, source_path: DevicePath, target_path: HostPath, *, verify_integrity: bool = True
) -> None:
...
) -> None: ...

@abc.abstractmethod
def remove(self, target_path: DevicePath) -> None:
...
def remove(self, target_path: DevicePath) -> None: ...

@abc.abstractmethod
def run_script(
self, content: AnyStr | StringIO | BytesIO, target_path: DevicePath | None = None
):
...
): ...
3 changes: 1 addition & 2 deletions micropy/pyd/backend_rshell.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ class RShell:
ASCII_XFER: bool
QUIET: bool

def connect(self, port: str):
...
def connect(self, port: str): ...


try:
Expand Down
4 changes: 2 additions & 2 deletions micropy/pyd/backend_upydevice.py
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ def write_file(
target_path = self.resolve_path(target_path)
self._pydevice.cmd("import gc")
self._pydevice.cmd("import ubinascii")
self._pydevice.cmd(f"f = open('{str(target_path)}', 'wb')")
self._pydevice.cmd(f"f = open('{target_path!s}', 'wb')")

content_iter = (
iterutils.chunked_iter(contents, self.BUFFER_SIZE)
Expand All @@ -212,7 +212,7 @@ def write_file(
)

content_size = len(contents)
consumer.on_start(name=f"Writing {str(target_path)}", size=content_size)
consumer.on_start(name=f"Writing {target_path!s}", size=content_size)

for chunk in content_iter:
cmd = (
Expand Down
3 changes: 1 addition & 2 deletions micropy/stubs/source.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@

class LocateStrategy(Protocol):
@abc.abstractmethod
def prepare(self, location: PathStr) -> Union[PathStr, tuple[PathStr, Callable[..., Any]]]:
...
def prepare(self, location: PathStr) -> Union[PathStr, tuple[PathStr, Callable[..., Any]]]: ...


logger = Log.add_logger(__name__, show_title=False)
Expand Down
1 change: 1 addition & 0 deletions micropy/utils/stub.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Micropy stub utils."""

from __future__ import annotations

import importlib.util
Expand Down
3 changes: 1 addition & 2 deletions micropy/utils/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,4 @@

@runtime_checkable
class SupportsLessThan(Protocol):
def __lt__(self, other: Any) -> bool:
...
def __lt__(self, other: Any) -> bool: ...
1 change: 1 addition & 0 deletions tests/data/esp32_test_stub/stubs/machine.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""
Module: 'machine' on esp8266 v1.9.4
"""

# MCU: (sysname='esp8266', nodename='esp8266', release='2.2.0-dev(9422289)', version='v1.9.4-8-ga9a3caad0 on 2018-05-11', machine='ESP module with ESP8266')
# Stubber: 1.1.2

Expand Down
1 change: 1 addition & 0 deletions tests/data/esp8266_test_stub/stubs/machine.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""
Module: 'machine' on esp8266 v1.9.4
"""

# MCU: (sysname='esp8266', nodename='esp8266', release='2.2.0-dev(9422289)', version='v1.9.4-8-ga9a3caad0 on 2018-05-11', machine='ESP module with ESP8266')
# Stubber: 1.1.2

Expand Down
1 change: 1 addition & 0 deletions tests/test_stubs/esp32_test_stub/stubs/machine.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""
Module: 'machine' on esp8266 v1.9.4
"""

# MCU: (sysname='esp8266', nodename='esp8266', release='2.2.0-dev(9422289)', version='v1.9.4-8-ga9a3caad0 on 2018-05-11', machine='ESP module with ESP8266')
# Stubber: 1.1.2

Expand Down
1 change: 1 addition & 0 deletions tests/test_stubs/esp8266_test_stub/stubs/machine.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
"""
Module: 'machine' on esp8266 v1.9.4
"""

# MCU: (sysname='esp8266', nodename='esp8266', release='2.2.0-dev(9422289)', version='v1.9.4-8-ga9a3caad0 on 2018-05-11', machine='ESP module with ESP8266')
# Stubber: 1.1.2

Expand Down

0 comments on commit ddae689

Please sign in to comment.