rfcindex.RFCIndex

class documentation

class RFCIndex:

Constructor: RFCIndex(cache_dir)

The RFC Index.

Method	`__init__`	Parameters: cache_dir -- If set, use this directory as a cache for Datatracker objects
Method	`bcp`	Undocumented
Method	`fyi`	Undocumented
Method	`rfc`	Undocumented
Method	`rfc_not_issued`	Undocumented
Method	`rfcs`	Undocumented
Method	`std`	Undocumented
Instance Variable	`cache_dir`	Undocumented
Method	`_download_index`	Undocumented
Method	`_is_cached`	Undocumented
Method	`_retrieve_index`	Undocumented
Instance Variable	`_bcp`	Undocumented
Instance Variable	`_fyi`	Undocumented
Instance Variable	`_rfc`	Undocumented
Instance Variable	`_rfc_not_issued`	Undocumented
Instance Variable	`_std`	Undocumented

def __init__(self, cache_dir: Optional[Path] = None): ¶

Parameters: cache_dir -- If set, use this directory as a cache for Datatracker objects

def bcp(self, bcp_id: str) -> Optional[BcpEntry]: ¶

Undocumented

def fyi(self, fyi_id: str) -> Optional[FyiEntry]: ¶

Undocumented

def rfc(self, rfc_id: str) -> Optional[RfcEntry]: ¶

Undocumented

def rfc_not_issued(self, rfc_id: str) -> Optional[RfcNotIssuedEntry]: ¶

Undocumented

def rfcs(self, since: str = '1969-01', until: str = '2038-01', stream: Optional[str] = None, area: Optional[str] = None, wg: Optional[str] = None, status: Optional[str] = None) -> Iterator[RfcEntry]: ¶

Undocumented

def std(self, std_id: str) -> Optional[StdEntry]: ¶

Undocumented

cache_dir = ¶

Undocumented

def _download_index(self) -> Optional[str]: ¶

Undocumented

def _is_cached(self, cache_filepath: Path) -> bool: ¶

Undocumented

def _retrieve_index(self) -> Optional[str]: ¶

Undocumented

_bcp: Dict[str, BcpEntry] = ¶

Undocumented

_fyi: Dict[str, FyiEntry] = ¶

Undocumented

_rfc: Dict[str, RfcEntry] = ¶

Undocumented

_rfc_not_issued: Dict[str, RfcNotIssuedEntry] = ¶

Undocumented

_std: Dict[str, StdEntry] = ¶

Undocumented