Refactors method signatures across UDS modules for improved readability and consistency. Updates from_conll_and_annotations, from_json, add_annotation, and various other methods in corpus.py, document.py, and graph.py to use a more structured format. This change enhances code clarity and maintains uniformity in method definitions throughout the codebase.

Author: aaronstevenwhite

decomp/semantics/uds/corpus.py

@@ -356,13 +356,15 @@ def _process_conll(self, split: str | None, udewt: bytes) -> None:
  spl.to_json(sentences_json_path, documents_json_path)
 
  @classmethod
- def from_conll_and_annotations(cls,
- corpus: Location,
- sentence_annotations: Sequence[Location] = [],
- document_annotations: Sequence[Location] = [],
- annotation_format: str = 'normalized',
- version: str = '2.0',
- name: str = 'ewt') -> 'UDSCorpus':
+ def from_conll_and_annotations(
+ cls,
+ corpus: Location,
+ sentence_annotations: Sequence[Location] = [],
+ document_annotations: Sequence[Location] = [],
+ annotation_format: str = 'normalized',
+ version: str = '2.0',
+ name: str = 'ewt'
+ ) -> 'UDSCorpus':
  """Load UDS graph corpus from CoNLL (dependencies) and JSON (annotations).
 
  This method should only be used if the UDS corpus is being
@@ -463,8 +465,11 @@ def _load_ud_ids(
  return ud_ids
 
  @classmethod
- def from_json(cls, sentences_jsonfile: Location,
- documents_jsonfile: Location) -> 'UDSCorpus':
+ def from_json(
+ cls,
+ sentences_jsonfile: Location,
+ documents_jsonfile: Location
+ ) -> 'UDSCorpus':
  """Load annotated UDS graph corpus (including annotations) from JSON.
 
  This is the suggested method for loading the UDS corpus.
@@ -541,8 +546,11 @@ def add_corpus_metadata(self, metadata: UDSCorpusMetadata) -> None:
  """
  self._metadata += metadata
 
- def add_annotation(self, sentence_annotation: list[UDSAnnotation] | None = None,
- document_annotation: list[UDSAnnotation] | None = None) -> None:
+ def add_annotation(
+ self,
+ sentence_annotation: list[UDSAnnotation] | None = None,
+ document_annotation: list[UDSAnnotation] | None = None
+ ) -> None:
  """Add annotations to UDS sentence and document graphs.
 
  Parameters
@@ -873,8 +881,11 @@ def sentence_properties(self, subspace: str | None = None) -> set[str]:
  """
  raise NotImplementedError
 
- def sentence_property_metadata(self, subspace: str,
- prop: str) -> UDSPropertyMetadata:
+ def sentence_property_metadata(
+ self,
+ subspace: str,
+ prop: str
+ ) -> UDSPropertyMetadata:
  """Return the metadata for a property in a sentence subspace.
 
  Parameters
@@ -906,8 +917,11 @@ def document_properties(self, subspace: str | None = None) -> set[str]:
  """
  raise NotImplementedError
 
- def document_property_metadata(self, subspace: str,
- prop: str) -> UDSPropertyMetadata:
+ def document_property_metadata(
+ self,
+ subspace: str,
+ prop: str
+ ) -> UDSPropertyMetadata:
  """Return the metadata for a property in a document subspace.
 
  Parameters

decomp/semantics/uds/document.py

@@ -50,9 +50,15 @@ class UDSDocument:
  initialized without edges from sentence_graphs
  """
 
- def __init__(self, sentence_graphs: SentenceGraphDict,
- sentence_ids: SentenceIDDict, name: str, genre: str,
- timestamp: str | None = None, doc_graph: UDSDocumentGraph | None = None):
+ def __init__(
+ self,
+ sentence_graphs: SentenceGraphDict,
+ sentence_ids: SentenceIDDict,
+ name: str,
+ genre: str,
+ timestamp: str | None = None,
+ doc_graph: UDSDocumentGraph | None = None
+ ):
  self.sentence_graphs: SentenceGraphDict = {}
  self.sentence_ids: SentenceIDDict = {}
  self.name = name
@@ -79,8 +85,13 @@ def to_dict(self) -> NetworkXGraphData:
  return self.document_graph.to_dict()
 
  @classmethod
- def from_dict(cls, document: dict[str, dict], sentence_graphs: dict[str, UDSSentenceGraph],
- sentence_ids: dict[str, str], name: str = 'UDS') -> 'UDSDocument':
+ def from_dict(
+ cls,
+ document: dict[str, dict],
+ sentence_graphs: dict[str, UDSSentenceGraph],
+ sentence_ids: dict[str, str],
+ name: str = 'UDS'
+ ) -> 'UDSDocument':
  """Construct a UDSDocument from a dictionary.
 
  Since only the document graphs are serialized, the sentence