compass.utilities.nt.ProcessKwargs#

class ProcessKwargs(known_local_docs, known_doc_urls, file_loader_kwargs=None, td_kwargs=None, tpe_kwargs=None, ppe_kwargs=None, max_num_concurrent_jurisdictions=25)#

Bases: tuple

Execution options passed to compass process

Parameters:

known_local_docs (list of path-like, optional) – Local ordinance files to seed the run. None disables the seed. By default, None.
known_doc_urls (list of str, optional) – Known ordinance URLs to prioritize during retrieval. By default, None.
file_loader_kwargs (dict, optional) – Keyword arguments forwarded to the document loader implementation. By default, None.
td_kwargs (dict, optional) – Additional configuration for top-level document discovery logic. By default, None.
tpe_kwargs (dict, optional) – Parameters controlling text parsing and extraction. By default, None.
ppe_kwargs (dict, optional) – Parameters controlling permitted-use parsing and extraction. By default, None.
max_num_concurrent_jurisdictions (int, default 25) – Maximum number of jurisdictions processed simultaneously. By default, 25.

Create new instance of ProcessKwargs(known_local_docs, known_doc_urls, file_loader_kwargs, td_kwargs, tpe_kwargs, ppe_kwargs, max_num_concurrent_jurisdictions)

Methods

`count`(value, /)	Return number of occurrences of value.
`index`(value[, start, stop])	Return first index of value.

Attributes

`file_loader_kwargs`	Alias for field number 2
`known_doc_urls`	Alias for field number 1
`known_local_docs`	Alias for field number 0
`max_num_concurrent_jurisdictions`	Alias for field number 6
`ppe_kwargs`	Alias for field number 5
`td_kwargs`	Alias for field number 3
`tpe_kwargs`	Alias for field number 4

__add__(value, /)#: Return self+value.

__mul__(value, /)#: Return self*value.

count(value, /)#: Return number of occurrences of value.

file_loader_kwargs#: Alias for field number 2

index(value, start=0, stop=9223372036854775807, /)#

Return first index of value.

Raises ValueError if the value is not present.

known_doc_urls#: Alias for field number 1

known_local_docs#: Alias for field number 0

max_num_concurrent_jurisdictions#: Alias for field number 6

ppe_kwargs#: Alias for field number 5

td_kwargs#: Alias for field number 3

tpe_kwargs#: Alias for field number 4