"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the base of all Mariadb stored datasets.
Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:
https://pyfunceble.github.io/#/special-thanks
Contributors:
https://pyfunceble.github.io/#/contributors
Project link:
https://github.com/funilrys/PyFunceble
Project documentation:
https://pyfunceble.readthedocs.io/en/dev/
Project homepage:
https://pyfunceble.github.io/
License:
::
Copyright 2017, 2018, 2019, 2020 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
import functools
from typing import Any, Generator, Optional, Union
from sqlalchemy.ext.declarative.api import DeclarativeMeta
from sqlalchemy.orm import Session
import PyFunceble.sessions
from PyFunceble.dataset.db_base import DBDatasetBase
[docs]class MariaDBDatasetBase(DBDatasetBase):
"""
Provides the base of all MariaDB stored dataset.
"""
STD_KEEP_SESSION_OPEN: bool = False
ORM_OBJ: Optional[DeclarativeMeta] = None
_keep_db_session_open: Optional[bool] = None
db_session: Optional[Session] = None
def __init__(
self,
*,
authorized: Optional[bool] = None,
remove_unneeded_fields: Optional[bool] = None,
keep_db_session_open: Optional[bool] = None,
) -> None:
if keep_db_session_open is not None:
self.keep_db_session_open = keep_db_session_open
else:
self.keep_db_session_open = self.STD_KEEP_SESSION_OPEN
super().__init__(
authorized=authorized, remove_unneeded_fields=remove_unneeded_fields
)
def __contains__(self, value: str) -> bool:
raise NotImplementedError()
def __getitem__(self, value: Any) -> Any:
raise NotImplementedError()
def __del__(self) -> None:
if isinstance(self.db_session, Session):
self.db_session.close()
[docs] def ensure_orm_obj_is_given(func): # pylint: disable=no-self-argument
"""
Ensures that the ORM object is given before launching the decorated
method.
:raise RuntimeError:
When :code:`ORM_OBJ` is not declared.
"""
@functools.wraps(func)
def wrapper(self, *args, **kwargs):
if not isinstance(self.ORM_OBJ, DeclarativeMeta):
raise RuntimeError("<self.ORM_OBJ> not given.")
return func(self, *args, **kwargs) # pylint: disable=not-callable
return wrapper
@property
def keep_db_session_open(self):
"""
Provides the current valur of the :code:`_keep_db_session_open` attribute.
"""
return self._keep_db_session_open
@keep_db_session_open.setter
def keep_db_session_open(self, value: bool) -> None:
"""
Sets the value of the :code:`_keep_db_session_open` attribute.
:param value:
The value to set.
:raise TypeError:
When the given :code:`value` is not a :py:class:`bool`
"""
if not isinstance(value, bool):
raise TypeError(f"<value> should be {bool}, {type(value)} given.")
self._keep_db_session_open = value
[docs] def set_keep_db_session_open(self, value: bool) -> "MariaDBDatasetBase":
"""
Sets the value of the :code:`_keep_db_session_open` attribute.
:param value:
The value to set.
"""
self.keep_db_session_open = value
return self
[docs] @DBDatasetBase.execute_if_authorized(None)
def get_content(self) -> Generator[dict, None, None]:
"""
Provides a generator which provides the next dataset to read.
"""
with PyFunceble.sessions.session_scope() as db_session:
for row in db_session.query(self.ORM_OBJ):
row = row.to_dict()
yield row
[docs] @DBDatasetBase.execute_if_authorized(None)
def update(self, row: Union[dict, DeclarativeMeta]) -> "MariaDBDatasetBase":
"""
Adds the given dataset into the database if it does not exists.
Update otherwise.
.. note::
This should be the prefered method for introduction of new dataset.
:raise TypeError:
When the given :code:`row` is not a :py:class:`dict` or
:class:`PyFunceble.database.sqlalchemy.base_schema.DeclarativeMeta`
"""
PyFunceble.facility.Logger.info("Started to update row.")
with PyFunceble.sessions.session_scope() as db_session:
existing_row = self.get_existing_row(row)
if existing_row:
for key, value in row.items():
if (
hasattr(existing_row, key)
and getattr(existing_row, key) != value
):
setattr(existing_row, key, value)
db_session.add(existing_row)
db_session.commit()
else:
self.add(row)
PyFunceble.facility.Logger.debug("Updated row:\n%r", row)
PyFunceble.facility.Logger.info("Finished to update row.")
return self
[docs] @DBDatasetBase.execute_if_authorized(None)
@ensure_orm_obj_is_given
def remove(self, row: Union[dict, DeclarativeMeta]) -> "MariaDBDatasetBase":
"""
Removes the given dataset from the database.
:param row:
The row or dataset to check.
:raise TypeError:
When the given :code:`row` is not a :py:class:`dict` or
:class:`PyFunceble.database.sqlalchemy.base_schema.DeclarativeMeta`
"""
if not isinstance(row, (dict, type(self.ORM_OBJ))):
raise TypeError(
f"<row> should be {dict} or {self.ORM_OBJ}, {type(row)} given."
)
PyFunceble.facility.Logger.info("Started to remove row.")
if not isinstance(row, type(self.ORM_OBJ)):
row = self.get_existing_row(row)
if row:
with PyFunceble.sessions.session_scope() as db_session:
db_session.delete(row)
db_session.commit()
PyFunceble.facility.Logger.debug("Removed row:\n%r", row)
PyFunceble.facility.Logger.info("Finished to remove row.")
return self
[docs] @DBDatasetBase.execute_if_authorized(False)
@ensure_orm_obj_is_given
def exists(self, row: Union[dict, DeclarativeMeta]) -> bool:
"""
Checks if the given dataset exists in our dataset.
:param row:
The row or dataset to check.
:raise TypeError:
When the given :code:`row` is not a :py:class:`dict` or
:class:`PyFunceble.database.sqlalchemy.base_schema.DeclarativeMeta`
"""
if not isinstance(row, (dict, type(self.ORM_OBJ))):
raise TypeError(
f"<row> should be {dict} or {self.ORM_OBJ}, {type(row)} given."
)
if isinstance(row, type(self.ORM_OBJ)):
row = row.to_dict()
with PyFunceble.sessions.session_scope() as db_session:
result = db_session.query(self.ORM_OBJ)
for field in self.COMPARISON_FIELDS:
result = result.filter(getattr(self.ORM_OBJ, field) == row[field])
return result.first() is not None
[docs] @DBDatasetBase.execute_if_authorized(None)
@ensure_orm_obj_is_given
def get_existing_row(
self, row: Union[dict, DeclarativeMeta]
) -> Optional[DeclarativeMeta]:
"""
Check if the given :code:`row` exists. And return the matiching
dataset.
:param row:
The row or dataset to check,
"""
if not isinstance(row, (dict, type(self.ORM_OBJ))):
raise TypeError(
f"<row> should be {dict} or {self.ORM_OBJ}, {type(row)} given."
)
if isinstance(row, type(self.ORM_OBJ)):
row = row.to_dict()
with PyFunceble.sessions.session_scope() as db_session:
result = db_session.query(self.ORM_OBJ)
for field in self.COMPARISON_FIELDS:
result = result.filter(getattr(self.ORM_OBJ, field) == row[field])
return result.first()
[docs] @DBDatasetBase.execute_if_authorized(None)
@ensure_orm_obj_is_given
def add(self, row: Union[dict, DeclarativeMeta]) -> "MariaDBDatasetBase":
"""
Adds the given dataset into the database.
:param row:
The row or dataset to add.
:raise TypeError:
When the given :code:`row` is not a :py:class:`dict` or
:class:`PyFunceble.database.sqlalchemy.base_schema.DeclarativeMeta`
"""
if not isinstance(row, (dict, type(self.ORM_OBJ))):
raise TypeError(
f"<row> should be {dict} or {self.ORM_OBJ}, {type(row)} given."
)
PyFunceble.facility.Logger.info("Started to add row.")
if not isinstance(row, type(self.ORM_OBJ)):
# pylint: disable=not-callable
dataset = self.ORM_OBJ()
else:
dataset = row
for key, value in row.items():
setattr(dataset, key, value)
with PyFunceble.sessions.session_scope() as db_session:
db_session.add(dataset)
db_session.commit()
PyFunceble.facility.Logger.debug("Added row:\n%r", row)
PyFunceble.facility.Logger.info("Finished to add row.")
return self