Skip to content

schemas

SQLiteDB dataclass

Define a simple SQLite database path.

Use this object's .create_empty_db() function to attempt to create a database at the object's .db_path property (this is a calculated property, available once the class is initialized).

Parameters:

Name Type Description Default
name str

The name of the database file

 field(default='demo')
ext str

The file extension to use (.db, .sqlite, etc)

 field(default='.sqlite')
location str

Path where database file will be created. Database file will be created at self.location/self.name + self.ext

 field(default=DB_DIR)

Returns

(SQLiteDB): An initialized `SQLiteDB` object
Source code in src/red_utils/std/sqlite_utils/schemas.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
@dataclass
class SQLiteDB:
    """Define a simple SQLite database path.

    Use this object's `.create_empty_db()` function to attempt to create a database at the object's `.db_path` property
    (this is a calculated property, available once the class is initialized).

    Params:
        name (str): The name of the database file
        ext (str): The file extension to use (`.db`, `.sqlite`, etc)
        location (str): Path where database file will be created. Database file will be created at `self.location`/`self.name` + `self.ext`

    Returns
    -------
        (SQLiteDB): An initialized `SQLiteDB` object

    """

    name: str = field(default="demo")
    ext: str = field(default=".sqlite")
    location: str = field(default=DB_DIR)

    @property
    def filename(self) -> str:
        _filename: str = f"{self.name}{self.ext}"

        return _filename

    @property
    def db_path(self) -> str:
        _path: str = f"{self.location}/{self.filename}"

        return _path

    @property
    def exists(self) -> bool:
        if Path(self.db_path).exists():
            return True
        else:
            return False

    @property
    def stat_str(self) -> str:
        _str: str = (
            f"[{self.filename}] | {'Exists' if self.exists else 'Does not exist'} @ {self.db_path}/"
        )

        return _str

    def create_empty_db(self) -> bool:
        if not self.exists:
            try:
                connection = sqlite3.Connection = sqlite3.connect(self.db_path)
                print(f"Initializing empty database file at: {self.db_path}")

                connection.close()

                return True
            except Exception as exc:
                print(
                    Exception(
                        f"Unhandled exception initializing an empty SQLite database at {self.db_path}. Details: {exc}"
                    )
                )

                return False
        else:
            return True

    def __post_init__(self):
        if not self.ext.startswith("."):
            self.ext = f".{self.ext}"

        if not Path(self.db_path).exists():
            Path(self.db_path).parent.mkdir(parents=True, exist_ok=True)