-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
moved meta-data related classes/methods into ldc.metadata module
- Loading branch information
Showing
21 changed files
with
127 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
from typing import Optional, Dict | ||
|
||
|
||
class MetaDataHandler(object): | ||
""" | ||
Mixin for classes that manage meta-data. | ||
""" | ||
|
||
def has_metadata(self) -> bool: | ||
""" | ||
Returns whether meta-data is present. | ||
:return: True if meta-data present | ||
:rtype: bool | ||
""" | ||
raise NotImplementedError() | ||
|
||
def get_metadata(self) -> Optional[Dict]: | ||
""" | ||
Returns the meta-data. | ||
:return: the meta-data, None if not available | ||
:rtype: dict | ||
""" | ||
raise NotImplementedError() | ||
|
||
def set_metadata(self, metadata: Optional[Dict]): | ||
""" | ||
Sets the meta-data to use. | ||
:param metadata: the new meta-data, can be None | ||
:type metadata: dict | ||
""" | ||
raise NotImplementedError() | ||
|
||
|
||
def get_metadata(o) -> Optional[Dict]: | ||
""" | ||
Retrieves the meta-data from the specified object. | ||
:param o: the object to get the meta-data from | ||
:return: the meta-data, None if not available | ||
""" | ||
if isinstance(o, MetaDataHandler): | ||
return o.get_metadata() | ||
if hasattr(o, "meta"): | ||
obj = getattr(o, "meta") | ||
if isinstance(obj, dict): | ||
return obj | ||
return None | ||
|
||
|
||
def add_metadata(meta: Optional[Dict], key: str, value) -> Dict: | ||
""" | ||
Adds the specified key/value pair to the meta-data. | ||
If the provided meta-data dictionary is empty, it gets instantiated. | ||
If value is None, nothing gets added. | ||
If value is a string and empty, nothing gets added. | ||
:param meta: the meta-data to add to | ||
:type meta: dict | ||
:param key: the key to store the value under | ||
:type key: str | ||
:param value: the value to store | ||
:return: the created or updated dictionary | ||
:rtype: dict | ||
""" | ||
if value is None: | ||
return meta | ||
if isinstance(value, str) and (len(value) == 0): | ||
return meta | ||
if meta is None: | ||
meta = dict() | ||
meta[key] = value | ||
return meta |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.