Skip to content

Commit

Permalink
perf: plugin load (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
antazoey authored Nov 14, 2024
1 parent 8511596 commit ce1cbfc
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 25 deletions.
10 changes: 5 additions & 5 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
rev: v5.0.0
hooks:
- id: check-yaml

Expand All @@ -10,24 +10,24 @@ repos:
- id: isort

- repo: https://github.com/psf/black
rev: 24.4.2
rev: 24.10.0
hooks:
- id: black
name: black

- repo: https://github.com/pycqa/flake8
rev: 7.0.0
rev: 7.1.1
hooks:
- id: flake8

- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.10.0
rev: v1.13.0
hooks:
- id: mypy
additional_dependencies: [types-setuptools, pydantic]

- repo: https://github.com/executablebooks/mdformat
rev: 0.7.17
rev: 0.7.18
hooks:
- id: mdformat
additional_dependencies: [mdformat-gfm, mdformat-frontmatter, mdformat-pyproject]
Expand Down
25 changes: 18 additions & 7 deletions ape_addressbook/__init__.py
Original file line number Diff line number Diff line change
@@ -1,20 +1,31 @@
from ape import plugins
from ape.types import AddressType

from .addressbook import AddressBookConfig, addressbook # noqa: F401
from .converters import AddressBookConverter


@plugins.register(plugins.Config)
def config_class():
from .addresses import AddressBookConfig

return AddressBookConfig


@plugins.register(plugins.ConversionPlugin)
def converters():
from ape.types import AddressType

from .converters import AddressBookConverter

return AddressType, AddressBookConverter


___all__ = [
"addressbook",
]
def __getattr__(name: str):
if name == "addressbook":
from ape_addressbook.addresses import addressbook

return addressbook

import ape_addressbook.addresses as module

return getattr(module, name)


___all__ = ["addressbook"]
15 changes: 10 additions & 5 deletions ape_addressbook/addressbook.py → ape_addressbook/addresses.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
from collections.abc import Iterator
from typing import cast
from typing import TYPE_CHECKING, cast

from ape.api import PluginConfig
from ape.logging import logger
from ape.types import AddressType
from ape.utils import ManagerAccessMixin
from eth_utils import is_checksum_address, to_checksum_address
from pydantic import model_validator
from pydantic_settings import SettingsConfigDict

if TYPE_CHECKING:
from ape.types import AddressType


def _validate_entries(entries: dict) -> dict:
validated: dict[str, AddressType] = {}
validated: dict[str, "AddressType"] = {}
for k, v in entries.items():
# Attempt to handle EVM-like addresses but if it fails,
# let it be in case it is for a more unique ecosystem.
Expand Down Expand Up @@ -67,7 +69,7 @@ def config(self) -> AddressBookConfig:
return cast(AddressBookConfig, config_obj)

@property
def registry(self) -> dict[str, AddressType]:
def registry(self) -> dict[str, "AddressType"]:
"""
The complete registry of addresses, including both global
and project addresses.
Expand All @@ -91,11 +93,14 @@ def aliases(self) -> Iterator[str]:
def __contains__(self, alias: str) -> bool:
return alias in self.aliases

def __getitem__(self, alias: str) -> AddressType:
def __getitem__(self, alias: str) -> "AddressType":
if alias not in self.aliases:
raise IndexError(f"Alias '{alias}' not in addressbook.")

return self.registry[alias]

def __iter__(self) -> Iterator[str]:
yield from self.aliases # dict like behavior


addressbook = AddressBook()
10 changes: 6 additions & 4 deletions ape_addressbook/converters.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
from typing import Any
from typing import TYPE_CHECKING, Any

from ape.api.convert import ConverterAPI
from ape.types import AddressType

from .addressbook import addressbook
from ape_addressbook import addressbook

if TYPE_CHECKING:
from ape.types import AddressType


class AddressBookConverter(ConverterAPI):
def is_convertible(self, value: Any) -> bool:
return isinstance(value, str) and value in addressbook

def convert(self, alias: str) -> AddressType:
def convert(self, alias: str) -> "AddressType":
return addressbook[alias]
2 changes: 2 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
[flake8]
max-line-length = 100
ignore = E704,W503,PYD002,TC003,TC006
exclude =
venv*
.eggs
docs
build
type-checking-pydantic-enabled = True
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@
"hypothesis>=6.2.0,<7.0", # Strategy-based fuzzer
],
"lint": [
"black>=24.4.2,<25", # Auto-formatter and linter
"mypy>=1.10.0,<2", # Static type analyzer
"black>=24.10.0,<25", # Auto-formatter and linter
"mypy>=1.13.0,<2", # Static type analyzer
"types-setuptools", # Needed for mypy type shed
"flake8>=7.0.0,<8", # Style linter
"flake8>=7.1.1,<8", # Style linter
"flake8-breakpoint>=1.1.0,<2", # Detect breakpoints left in code
"flake8-print>=5.0.0,<6", # Detect print statements left in code
"isort>=5.13.2,<6", # Import sorting linter
"mdformat>=0.7.17", # Auto-formatter for markdown
"mdformat>=0.7.18", # Auto-formatter for markdown
"mdformat-gfm>=0.3.5", # Needed for formatting GitHub-flavored markdown
"mdformat-frontmatter>=0.4.1", # Needed for frontmatters-style headers in issue templates
"mdformat-pyproject>=0.0.1", # Allows configuring in pyproject.toml
Expand Down

0 comments on commit ce1cbfc

Please sign in to comment.