Readers¶
Converting simple structured data from XML or JSON into authorityspoke objects.
These functions will usually be called by functions from the io.loaders module after they import some data from a file.
Build a URI for the
Codebased on its XML metadata.Note
This handles California state statutes only with a mockup, which can only refer to the Penal and Evidence Codes.
- Return type
- Returns
The United States Legislative Markup (USLM) identifier that describes the document as a whole, if available in the XML. Otherwise returns a pseudo-USLM identifier.
Provide “title” identifier for the
CodeXML.- Return type
- Returns
the contents of an XML
titleelement that describes theCode, if any. Otherwise returns a descriptive name that may not exactly appear in the XML.
Determine if the Code XML has the USLM schema.
- Return type
Create a new
Enactmentobject using imported JSON data.The new
Enactmentcan be composed from aCodereferenced in theregimeparameter.- Parameters
record (
Dict[str,Union[str,List[Union[str,Dict[str,str]]]]]) –dictwith string fields from JSON for constructing newEnactmentcode (
Optional[Code]) – theCodethat is the source for thisEnactmentregime (
Optional[Regime]) – theRegimewhere theCodethat is the source for thisEnactmentcan be found, or where it should be added
- Return type
- Returns
a new
Enactmentobject, optionally with text links.
Create a new
Enactmentobject using imported JSON data.The new
Enactmentcan be composed from aCodereferenced in theregimeparameter.- Parameters
record (
List[Dict[str,Union[str,List[Union[str,Dict[str,str]]]]]]) – sequence ofdicts with string fields from JSON for constructing newEnactmentscode (
Optional[Code]) – aCodethat is the source for everyEnactmentto be loaded, if they all come from the sameCoderegime (
Optional[Regime]) – theRegimewhere theCodes that are the source for thisEnactmentcan be found, or where it should be added
- Return type
- Returns
a list of new
Enactmentobjects, optionally with text links.
Construct a
Factafter loading a dict from JSON.
Turn fields from JSON into a
Factorobject.
Turn fields from JSON into a
Factorobject.
Create new
Holdingobject from simple datatypes from JSON input.Will yield multiple items if
exclusive: Trueis present inrecord.- Parameters
record (
Dict[str,Union[Dict[str,Union[Dict[str,Sequence[Dict[str,Union[Dict[str,Union[str,bool]],Sequence[Any],str,bool]]]],Sequence[Dict[str,Union[str,List[Union[str,Dict[str,str]]]]]],str,bool]],str,bool]]) – dict of values for constructingHoldingregime (
Optional[Regime]) – Collection ofJurisdictions and correspondingCodes for discoveringEnactments to reference in the newHolding.many – if True, record represents a list of
Holdings rather than just one.
- Return type
- Returns
New
Holding, and an updated dictionary with mentionedFactors as keys and theirTextQuoteSelectors as values.
Alias for field number 0
Alias for field number 1
Alias for field number 2
Load a list of
Holdingss from JSON, with optional text links.- Parameters
record (
List[Dict[str,Union[Dict[str,Union[Dict[str,Sequence[Dict[str,Union[Dict[str,Union[str,bool]],Sequence[Any],str,bool]]]],Sequence[Dict[str,Union[str,List[Union[str,Dict[str,str]]]]]],str,bool]],str,bool]]]) – a list of dicts representing holdings, in the JSON input format- Parame regime
A collection of
Jurisdictions and theCodes that have been enacted in each. Used for constructingEnactments referenced byHoldings.- Return type
- Returns
a list of
Holdingobjects, optionally with an index matchingFactors to selectors.
Create and return one or more
Opinionobjects from a dict API response.Relies on the JSON format from the Caselaw Access Project API.
This function is a more convenient way to call read_opinions with an entire case from the CAP API as a single parameter.
