Development

ouroboroscoding · ouroboroscoding · commit d4ce97813773 · 2023-04-09T17:02:27.000-04:00
- Reversed start max in Limit to be max start
- Fixed annotations/typings in Data and Storage
- Added exceptions and types to top level, and remove Limit (now in types.Limit)
diff --git a/record/__init__.py b/record/__init__.py
@@ -10,13 +10,9 @@
 __created__		= "2023-03-21"
 
 # Limit imports
-__all__ = ['Data', 'Limit', 'Storage']
+__all__ = ['Data', 'exceptions', 'Storage', 'types']
 
 # Local modules
-from . import data, exceptions, storage, types
-
-# Re-Export just the classes/types
-Data = data.Data
-Limit = types.Limit
-RecordDuplicate = exceptions.RecordDuplicate
-Storage = storage.Storage
+from . import exceptions, types
+from .data import Data
+from .storage import Storage
diff --git a/record/data.py b/record/data.py
@@ -3,6 +3,7 @@
 
 Holds data associated with records as well as methods to store that data
 """
+from __future__ import annotations
 
 __author__		= "Chris Nasr"
 __copyright__	= "Ouroboros Coding Inc."
@@ -43,9 +44,6 @@ def __init__(self, storage: callable, value: dict = {}):
 		# Init the list of fields that have changed
 		self._changed = []
 
-	def __delattr__(self, __name: str) -> None:
-		return super().__delattr__(__name)
-
 	def __contains__(self, key):
 		"""Contains
 
@@ -77,7 +75,7 @@ def __delattr__(self, name: str) -> None:
 		except KeyError as e:
 			raise AttributeError(*e.args)
 
-	def __delitem__(self, key):
+	def __delitem__(self, key) -> None:
 		"""Del(ete) Item
 
 		Overrides python magic method __delitem__ for deleting a key from a dict
@@ -150,7 +148,7 @@ def __setattr__(self, name: str, value: any) -> None:
 		except KeyError as e:
 			raise AttributeError(*e.args)
 
-	def __setitem__(self, key, value):
+	def __setitem__(self, key, value) -> None:
 		"""Set Item
 
 		Overrides python magic method __setitem__ for setting a key in a dict
@@ -181,7 +179,7 @@ def __repr__(self) -> str:
 			str(self._value)
 		)
 
-	def __str__(self):
+	def __str__(self) -> str:
 		"""String
 
 		Overrides python magic method __str__ to return a string representing
@@ -229,13 +227,13 @@ def changed(self, field: str) -> bool:
 			# Call the instances changed and return that
 			return self[field].changed()
 
-	def changes(self) -> list:
+	def changes(self) -> list[str]:
 		"""Changes
 
 		Returns the list of fields that have been changed
 
 		Returns:
-			list
+			str[]
 		"""
 		return list(self._changed.keys())
 
@@ -253,15 +251,15 @@ def clean(self) -> None:
 		self._value = self._storage.clean(self._value)
 
 	@property
-	def errors(self) -> list:
+	def errors(self) -> list[list[str]]:
 		"""Errors
 
 		Read only property that returns the list of errors from the last failed
 		valid call
 		"""
 		return copy(self._errors)
 
-	def field_get(self, field, default=None):
+	def field_get(self, field: str, default = None):
 		"""Field Get
 
 		Returns a specific field, if it's not found, returns the default
@@ -270,7 +268,7 @@ def field_get(self, field, default=None):
 
 		Arguments:
 			field (str): The field to get
-			default (mixed): Returned if the field doesn't exist
+			default (any): Returned if the field doesn't exist
 
 		Returns:
 			any
@@ -283,7 +281,7 @@ def field_get(self, field, default=None):
 		# Return the field
 		return self._value[field]
 
-	def field_remove(self, field: str):
+	def field_remove(self, field: str) -> Data:
 		"""Field Remove
 
 		Deletes a specific field from the record value
@@ -318,7 +316,7 @@ def field_remove(self, field: str):
 		# Return self for chaining
 		return self
 
-	def field_set(self, field, value):
+	def field_set(self, field: str, value: any) -> Data:
 		"""Field Set
 
 		Sets a specific field in a record
diff --git a/record/storage.py b/record/storage.py
@@ -36,31 +36,30 @@ class Storage(Tree, abc.ABC):
 	"""
 
 	@abc.abstractmethod
-	def add(self, value: dict | list) -> str | list:
+	def add(self, value: dict) -> str | list:
 		"""Add
 
-		Adds one or more raw records to the storage system
+		Adds one raw record to the storage system
 
 		Arguments:
-			value (dict | dict[]): One or more dictionaries of fields to data
+			value (dict): A dictionary of fields to data
 
 		Returns:
-			The ID or IDs of the added records
+			The ID of the added record
 		"""
 		pass
 
 	@abc.abstractmethod
-	def create(self, value: dict | list = {}) -> Data | list:
+	def create(self, value: dict = {}) -> Data | list:
 		"""Create
 
-		Creates one or more new data objects associated with the Storage
-		instance
+		Creates a new data object associated with the Storage instance
 
 		Arguments:
-			value (dict | list): The initial values to set for the record(s)
+			value (dict): The initial values to set for the record
 
 		Returns:
-			Data | Data[]
+			Data
 		"""
 		pass
 
@@ -94,13 +93,13 @@ def exists(self, _id: str):
 
 	@abc.abstractmethod
 	def fetch(self,
-		_id: str | list = None,
+		_id: str | list[str] = None,
 		filter: dict = None,
 		limit: int | Limit = None,
-		fields: list = None,
-		raw: bool | list = False,
+		fields: list[str] = None,
+		raw: bool | list[str] = False,
 		options: dict = None
-	) -> list | dict | Data:
+	) -> Data | list[Data] | dict | list[dict]:
 		"""Fetch
 
 		Gets one, many, or all records from the storage system associated with
@@ -133,7 +132,7 @@ def install(self) -> bool:
 		pass
 
 	@abc.abstractmethod
-	def remove(self, _id: str | list = None, filter: dict = None):
+	def remove(self, _id: str | list[str] = None, filter: dict = None):
 		"""Remove
 
 		Removes one or more records from storage by ID or filter
@@ -159,7 +158,10 @@ def revision_add(cls, _id: str, changes: dict):
 		pass
 
 	@classmethod
-	def revision_generate(cls, old: dict | list, new: dict | list) -> dict | None:
+	def revision_generate(cls,
+		old: dict | list,
+		new: dict | list
+	) -> dict | None:
 		"""Revision Generate
 
 		Generates the list of changes between two records
diff --git a/record/types.py b/record/types.py
@@ -15,8 +15,8 @@
 # Python imports
 from collections import namedtuple
 
-Limit = namedtuple('Limit', 'start max')
+Limit = namedtuple('Limit', 'max start')
 """Limit
 
-Used to denote the starting point, and max number, of records when fetching them
+Used to denote the max number, and starting point, of records when fetching them
 """
