Added the "accounting-init-db" console command to replace the trivial "accounting-init-base", "accounting-init-accounts" and "accounting-init-currencies" console commands.

src/accounting/__init__.py

@@ -61,6 +61,9 @@ def init_app(app: Flask, user_utils: UserUtilityInterface,
     bp.add_app_template_global(default_currency_code,
                                "accounting_default_currency_code")
 
+    from .commands import init_db_command
+    app.cli.add_command(init_db_command)
+
     from . import locale
     locale.init_app(app, bp)
 

src/accounting/account/__init__.py

@@ -19,6 +19,8 @@
 """
 from flask import Flask, Blueprint
 
+from .commands import init_accounts_command
+
 
 def init_app(app: Flask, bp: Blueprint) -> None:
     """Initialize the application.
@@ -32,6 +34,3 @@ def init_app(app: Flask, bp: Blueprint) -> None:
 
     from .views import bp as account_bp
     bp.register_blueprint(account_bp, url_prefix="/accounts")
-
-    from .commands import init_accounts_command
-    app.cli.add_command(init_accounts_command)

src/accounting/account/commands.py

@@ -17,44 +17,19 @@
 """The console commands for the account management.
 
 """
-import os
 from secrets import randbelow
 
 import click
-from flask.cli import with_appcontext
 
 from accounting import db
 from accounting.models import BaseAccount, Account, AccountL10n
-from accounting.utils.user import has_user, get_user_pk
+from accounting.utils.user import get_user_pk
 
 AccountData = tuple[int, str, int, str, str, str, bool]
 """The format of the account data, as a list of (ID, base account code, number,
 English, Traditional Chinese, Simplified Chinese, is-need-offset) tuples."""
 
 
-def __validate_username(ctx: click.core.Context, param: click.core.Option,
-                        value: str) -> str:
-    """Validates the username for the click console command.
-
-    :param ctx: The console command context.
-    :param param: The console command option.
-    :param value: The username.
-    :raise click.BadParameter: When validation fails.
-    :return: The username.
-    """
-    value = value.strip()
-    if value == "":
-        raise click.BadParameter("Username empty.")
-    if not has_user(value):
-        raise click.BadParameter(f"User {value} does not exist.")
-    return value
-
-
-@click.command("accounting-init-accounts")
-@click.option("-u", "--username", metavar="USERNAME", prompt=True,
-              help="The username.", callback=__validate_username,
-              default=lambda: os.getlogin())
-@with_appcontext
 def init_accounts_command(username: str) -> None:
     """Initializes the accounts."""
     creator_pk: int = get_user_pk(username)
@@ -63,8 +38,6 @@ def init_accounts_command(username: str) -> None:
         .filter(db.func.length(BaseAccount.code) == 4)\
         .order_by(BaseAccount.code).all()
     if len(bases) == 0:
-        click.echo("Please initialize the base accounts with "
-                   "\"flask accounting-init-base\" first.")
         raise click.Abort
 
     existing: list[Account] = Account.query.all()
@@ -73,7 +46,6 @@ def init_accounts_command(username: str) -> None:
     bases_to_add: list[BaseAccount] = [x for x in bases
                                        if x.code not in existing_base_code]
     if len(bases_to_add) == 0:
-        click.echo("No more account to import.")
         return
 
     existing_id: set[int] = {x.id for x in existing}
@@ -96,7 +68,6 @@ def init_accounts_command(username: str) -> None:
         data.append((get_new_id(), base.code, 1, base.title_l10n,
                      l10n["zh_Hant"], l10n["zh_Hans"], is_need_offset))
     __add_accounting_accounts(data, creator_pk)
-    click.echo(F"{len(data)} added.  Accounting accounts initialized.")
 
 
 def __is_need_offset(base_code: str) -> bool:
@@ -146,4 +117,3 @@ def __add_accounting_accounts(data: list[AccountData], creator_pk: int)\
                                for y in (("zh_Hant", x[4]), ("zh_Hans", x[5]))]
     db.session.bulk_save_objects(accounts)
     db.session.bulk_save_objects(l10n)
-    db.session.commit()

src/accounting/base_account/__init__.py

@@ -19,6 +19,8 @@
 """
 from flask import Flask, Blueprint
 
+from .commands import init_base_accounts_command
+
 
 def init_app(app: Flask, bp: Blueprint) -> None:
     """Initialize the application.
@@ -32,6 +34,3 @@ def init_app(app: Flask, bp: Blueprint) -> None:
 
     from .views import bp as base_account_bp
     bp.register_blueprint(base_account_bp, url_prefix="/base-accounts")
-
-    from .commands import init_base_accounts_command
-    app.cli.add_command(init_base_accounts_command)

src/accounting/base_account/commands.py

@@ -19,22 +19,17 @@
 """
 import csv
 
-import click
 import sqlalchemy as sa
-from flask.cli import with_appcontext
 
 from accounting import data_dir
 from accounting import db
 from accounting.models import BaseAccount, BaseAccountL10n
 
 
-@click.command("accounting-init-base")
-@with_appcontext
 def init_base_accounts_command() -> None:
     """Initializes the base accounts."""
     if BaseAccount.query.first() is not None:
-        click.echo("Base accounts already exist.")
-        raise click.Abort
+        return
 
     with open(data_dir / "base_accounts.csv") as fp:
         data: list[dict[str, str]] = [x for x in csv.DictReader(fp)]
@@ -48,5 +43,3 @@ def init_base_accounts_command() -> None:
                                        for x in data for y in locales]
     db.session.execute(sa.insert(BaseAccount), account_data)
     db.session.execute(sa.insert(BaseAccountL10n), l10n_data)
-    db.session.commit()
-    click.echo("Base accounts initialized.")

src/accounting/commands.py

@@ -0,0 +1,62 @@
+# The Mia! Accounting Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/4/10
+
+#  Copyright (c) 2023 imacat.
+#
+#  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.
+"""The console commands.
+
+"""
+import os
+
+import click
+from flask.cli import with_appcontext
+
+from accounting import db
+from accounting.account import init_accounts_command
+from accounting.base_account import init_base_accounts_command
+from accounting.currency import init_currencies_command
+from accounting.utils.user import has_user
+
+
+def __validate_username(ctx: click.core.Context, param: click.core.Option,
+                        value: str) -> str:
+    """Validates the username for the click console command.
+
+    :param ctx: The console command context.
+    :param param: The console command option.
+    :param value: The username.
+    :raise click.BadParameter: When validation fails.
+    :return: The username.
+    """
+    value = value.strip()
+    if value == "":
+        raise click.BadParameter("Username empty.")
+    if not has_user(value):
+        raise click.BadParameter(f"User {value} does not exist.")
+    return value
+
+
+@click.command("accounting-init-db")
+@click.option("-u", "--username", metavar="USERNAME", prompt=True,
+              help="The username.", callback=__validate_username,
+              default=lambda: os.getlogin())
+@with_appcontext
+def init_db_command(username: str) -> None:
+    """Initializes the accounting database."""
+    db.create_all()
+    init_base_accounts_command()
+    init_accounts_command(username)
+    init_currencies_command(username)
+    db.session.commit()
+    click.echo("Accounting database initialized.")

src/accounting/currency/__init__.py

@@ -19,6 +19,8 @@
 """
 from flask import Flask, Blueprint
 
+from .commands import init_currencies_command
+
 
 def init_app(app: Flask, bp: Blueprint) -> None:
     """Initialize the application.
@@ -33,6 +35,3 @@ def init_app(app: Flask, bp: Blueprint) -> None:
     from .views import bp as currency_bp, api_bp as currency_api_bp
     bp.register_blueprint(currency_bp, url_prefix="/currencies")
     bp.register_blueprint(currency_api_bp, url_prefix="/api/currencies")
-
-    from .commands import init_currencies_command
-    app.cli.add_command(init_currencies_command)

src/accounting/currency/commands.py

@@ -18,41 +18,15 @@
 
 """
 import csv
-import os
 import typing as t
 
-import click
 import sqlalchemy as sa
-from flask.cli import with_appcontext
 
 from accounting import db, data_dir
 from accounting.models import Currency, CurrencyL10n
-from accounting.utils.user import has_user, get_user_pk
+from accounting.utils.user import get_user_pk
 
 
-def __validate_username(ctx: click.core.Context, param: click.core.Option,
-                        value: str) -> str:
-    """Validates the username for the click console command.
-
-    :param ctx: The console command context.
-    :param param: The console command option.
-    :param value: The username.
-    :raise click.BadParameter: When validation fails.
-    :return: The username.
-    """
-    value = value.strip()
-    if value == "":
-        raise click.BadParameter("Username empty.")
-    if not has_user(value):
-        raise click.BadParameter(f"User {value} does not exist.")
-    return value
-
-
-@click.command("accounting-init-currencies")
-@click.option("-u", "--username", metavar="USERNAME", prompt=True,
-              help="The username.", callback=__validate_username,
-              default=lambda: os.getlogin())
-@with_appcontext
 def init_currencies_command(username: str) -> None:
     """Initializes the currencies."""
     existing_codes: set[str] = {x.code for x in Currency.query.all()}
@@ -62,7 +36,6 @@ def init_currencies_command(username: str) -> None:
     to_add: list[dict[str, str]] = [x for x in data
                                     if x["code"] not in existing_codes]
     if len(to_add) == 0:
-        click.echo("No more currency to add.")
         return
 
     creator_pk: int = get_user_pk(username)
@@ -78,6 +51,3 @@ def init_currencies_command(username: str) -> None:
                                        for x in to_add for y in locales]
     db.session.execute(sa.insert(Currency), currency_data)
     db.session.execute(sa.insert(CurrencyL10n), l10n_data)
-    db.session.commit()
-
-    click.echo(F"{len(to_add)} added.  Currencies initialized.")