Classes

class Sqlite__DB__Files (db_path=None, db_name=None)

A mixin class to strictly assign keyword arguments to pre-defined instance attributes during initialization.

This base class provides an init method that assigns values from keyword arguments to instance attributes. If an attribute with the same name as a key from the kwargs is defined in the class, it will be set to the value from kwargs. If the key does not match any predefined attribute names, an exception is raised.

This behavior enforces strict control over the attributes of instances, ensuring that only predefined attributes can be set at the time of instantiation and avoids silent attribute creation which can lead to bugs in the code.

Usage

class MyConfigurableClass(Kwargs_To_Self): attribute1 = 'default_value' attribute2 = True attribute3 : str attribute4 : list attribute4 : int = 42

# Other methods can be added here

Correctly override default values by passing keyword arguments

instance = MyConfigurableClass(attribute1='new_value', attribute2=False)

This will raise an exception as 'attribute3' is not predefined

instance = MyConfigurableClass(attribute3='invalid_attribute')

this will also assign the default value to any variable that has a type defined. In the example above the default values (mapped by default__kwargs and locals) will be: attribute1 = 'default_value' attribute2 = True attribute3 = '' # default value of str attribute4 = [] # default value of list attribute4 = 42 # defined value in the class

Note

It is important that all attributes which may be set at instantiation are predefined in the class. Failure to do so will result in an exception being raised.

Methods

init(**kwargs): The initializer that handles the assignment of keyword arguments to instance attributes. It enforces strict attribute assignment rules, only allowing attributes that are already defined in the class to be set.

Initialize an instance of the derived class, strictly assigning provided keyword arguments to corresponding instance attributes.

Parameters

**kwargs: Variable length keyword arguments.

Raises

Exception

If a key from kwargs does not correspond to any attribute pre-defined in the class, an exception is raised to prevent setting an undefined attribute.

Expand source code

class Sqlite__DB__Files(Sqlite__DB__Local):

    def __init__(self, db_path=None, db_name=None):
        super().__init__(db_path=db_path, db_name=db_name)

    def add_file(self, path, contents=None, metadata=None):
        return self.table_files().add_file(path, contents, metadata)

    def clear_table(self):
        self.table_files().clear()

    def delete_file(self, path):
        return self.table_files().delete_file(path)

    def file(self, path, include_contents=False):
        return self.table_files().file(path, include_contents=include_contents)

    def file_exists(self, path):
        return self.table_files().file_exists(path)

    def file_names(self):
        return self.table_files().select_field_values('path')
    @cache_on_self
    def table_files(self):
        return Sqlite__Table__Files(database=self).setup()

    @index_by
    def files(self,include_contents=False):
        return self.table_files().files(include_contents=include_contents)

    def files__with_content(self):
        return self.files(include_contents=True)

    def files__by_path(self):
        return self.files(index_by='path')

    def setup(self):
        self.table_files()
        return self

Ancestors

• Sqlite__DB__Local
• Sqlite__Database
• Kwargs_To_Self

Methods

def add_file(self, path, contents=None, metadata=None)

Expand source code

def add_file(self, path, contents=None, metadata=None):
    return self.table_files().add_file(path, contents, metadata)

def clear_table(self)

Expand source code

def clear_table(self):
    self.table_files().clear()

def delete_file(self, path)

Expand source code

def delete_file(self, path):
    return self.table_files().delete_file(path)

def file(self, path, include_contents=False)

Expand source code

def file(self, path, include_contents=False):
    return self.table_files().file(path, include_contents=include_contents)

def file_exists(self, path)

Expand source code

def file_exists(self, path):
    return self.table_files().file_exists(path)

def file_names(self)

Expand source code

def file_names(self):
    return self.table_files().select_field_values('path')

def files(self, include_contents=False)

Expand source code

@index_by
def files(self,include_contents=False):
    return self.table_files().files(include_contents=include_contents)

def files__by_path(self)

Expand source code

def files__by_path(self):
    return self.files(index_by='path')

def files__with_content(self)

Expand source code

def files__with_content(self):
    return self.files(include_contents=True)

def setup(self)

Expand source code

def setup(self):
    self.table_files()
    return self

def table_files(self)

Expand source code

@cache_on_self
def table_files(self):
    return Sqlite__Table__Files(database=self).setup()

Inherited members

• Sqlite__DB__Local:
  • update_from_kwargs