text stringlengths 1 93.6k |
|---|
) -> Optional[docspec.ApiObject]:
|
resolved = self._resolve_reference_in_members(obj, ref_split)
|
if resolved and not self._excluded(resolved, exclusions):
|
return resolved
|
if isinstance(obj, docspec.HasMembers):
|
for member in obj.members:
|
resolved = _recurse(member)
|
if resolved and not self._excluded(
|
resolved, exclusions
|
):
|
return resolved
|
return None
|
for module in suite:
|
resolved = _recurse(module)
|
if resolved and not self._excluded(resolved, exclusions):
|
return resolved
|
return None
|
def _resolve_reference_in_members(
|
self, obj: Optional[docspec.ApiObject], ref: List[str]
|
) -> Optional[docspec.ApiObject]:
|
if not obj:
|
return None
|
fullref = ".".join(ref)
|
for part_name in ref:
|
retrieved = docspec.get_member(
|
obj, part_name
|
) or docspec.get_member(obj, fullref)
|
if retrieved:
|
return retrieved
|
return None
|
def _excluded(
|
self,
|
obj: docspec.ApiObject,
|
exclusions: Optional[List[Type[docspec.ApiObject]]] = None,
|
) -> bool:
|
if not exclusions:
|
return False
|
return (
|
any(isinstance(obj, exc) for exc in exclusions)
|
if exclusions
|
else False
|
)
|
class MayimFilter(FilterProcessor):
|
def _match(self, obj: docspec.ApiObject) -> bool:
|
result = super()._match(obj)
|
if result:
|
result = self._additional(obj)
|
return result
|
def _additional(self, obj: docspec.ApiObject) -> bool:
|
if isinstance(obj, docspec.Indirection) and not obj.target.startswith(
|
"."
|
):
|
return False
|
elif isinstance(obj, docspec.Variable) and obj.name.isupper():
|
return False
|
elif obj.name.startswith("_") and obj.name not in WHITELIST:
|
return False
|
return True
|
@dataclass
|
class MayimSourceLinker(SourceLinker):
|
def get_source_url(self, obj: docspec.ApiObject) -> Optional[str]:
|
base = "https://github.com/ahopkins/mayim/tree/main/"
|
return base + obj.location.filename + f"#L{obj.location.lineno}"
|
context = Context(directory=".")
|
loader = PythonLoader(
|
packages=["mayim"],
|
)
|
source_linker = MayimSourceLinker()
|
renderer = MayimRenderer(
|
render_module_header=False,
|
insert_header_anchors=False,
|
render_page_title=True,
|
descriptive_class_title=False,
|
signature_code_block=True,
|
use_fixed_header_levels=False,
|
source_linker=source_linker,
|
code_headers=True,
|
render_typehint_in_data_header=True,
|
signature_with_decorators=True,
|
render_toc=True,
|
)
|
source_linker.init(context)
|
loader.init(context)
|
renderer.init(context)
|
modules = list(sorted(loader.load(), key=attrgetter("name")))
|
suite = ApiSuite(modules)
|
resolver = renderer.get_resolver(modules)
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.