Skip to content

Commit

Permalink
Refactor containers and kml class #286
Browse files Browse the repository at this point in the history
  • Loading branch information
cleder committed Dec 20, 2023
1 parent d3ed751 commit fc183b7
Show file tree
Hide file tree
Showing 6 changed files with 243 additions and 300 deletions.
14 changes: 4 additions & 10 deletions fastkml/containers.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
from typing import Any
from typing import Dict
from typing import Iterable
from typing import Iterator
from typing import List
from typing import Optional
from typing import Union
Expand Down Expand Up @@ -102,20 +101,15 @@ def __init__(
region=region,
extended_data=extended_data,
)
self._features = features or []

def features(self) -> Iterator[_Feature]:
"""Iterate over features."""
assert self._features is not None
yield from self._features
self.features = features or []

def etree_element(
self,
precision: Optional[int] = None,
verbosity: Verbosity = Verbosity.normal,
) -> Element:
element = super().etree_element(precision=precision, verbosity=verbosity)
for feature in self.features():
for feature in self.features:
element.append(feature.etree_element())
return element

Expand All @@ -124,8 +118,8 @@ def append(self, kmlobj: _Feature) -> None:
if kmlobj is self:
msg = "Cannot append self"
raise ValueError(msg)
assert self._features is not None
self._features.append(kmlobj)
assert self.features is not None
self.features.append(kmlobj)

@classmethod
def _get_kwargs(
Expand Down
52 changes: 51 additions & 1 deletion fastkml/helpers.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""Helper functions for fastkml."""

from enum import Enum
from typing import Dict
from typing import List
from typing import Optional
Expand Down Expand Up @@ -44,6 +44,39 @@ def bool_subelement(
subelement.text = str(int(getattr(obj, attr_name)))


def float_subelement(
obj: _BaseObject,
*,
element: Element,
attr_name: str,
node_name: str,
precision: Optional[int],
) -> None:
"""Set the value of an attribute from a subelement with a text node."""
if getattr(obj, attr_name, None):
subelement = config.etree.SubElement( # type: ignore[attr-defined]
element,
f"{obj.ns}{node_name}",
)
subelement.text = str(round(getattr(obj, attr_name), precision))


def enum_subelement(
obj: _BaseObject,
*,
element: Element,
attr_name: str,
node_name: str,
) -> None:
"""Set the value of an attribute from a subelement with a text node."""
if getattr(obj, attr_name, None):
subelement = config.etree.SubElement( # type: ignore[attr-defined]
element,
f"{obj.ns}{node_name}",
)
subelement.text = getattr(obj, attr_name).value


def xml_subelement(
obj: _BaseObject,
*,
Expand Down Expand Up @@ -109,6 +142,23 @@ def subelement_bool_kwarg(
return {}


def subelement_enum_kwarg(
*,
element: Element,
ns: str,
node_name: str,
kwarg: str,
enum_class: Type[Enum],
strict: bool,
) -> Dict[str, Enum]:
node = element.find(f"{ns}{node_name}")
if node is None:
return {}
if node.text and node.text.strip():
return {kwarg: enum_class(node.text.strip())}
return {}


def xml_subelement_kwarg(
*,
element: Element,
Expand Down
11 changes: 3 additions & 8 deletions fastkml/kml.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
from typing import Any
from typing import Dict
from typing import Iterable
from typing import Iterator
from typing import List
from typing import Optional
from typing import Union
Expand Down Expand Up @@ -68,7 +67,7 @@ def __init__(
ns=ns,
name_spaces=name_spaces,
)
self._features = list(features) if features is not None else []
self.features = list(features) if features is not None else []

def etree_element(
self,
Expand All @@ -91,20 +90,16 @@ def etree_element(
root = config.etree.Element( # type: ignore[attr-defined]
f"{self.ns}kml",
)
for feature in self.features():
for feature in self.features:
root.append(feature.etree_element(precision=precision, verbosity=verbosity))
return cast(Element, root)

def features(self) -> Iterator[Union[Folder, Document, Placemark]]:
"""Iterate over features."""
yield from self._features

def append(self, kmlobj: Union[Folder, Document, Placemark]) -> None:
"""Append a feature."""
if id(kmlobj) == id(self):
msg = "Cannot append self"
raise ValueError(msg)
self._features.append(kmlobj)
self.features.append(kmlobj)

@classmethod
def _get_kwargs(
Expand Down

0 comments on commit fc183b7

Please sign in to comment.