django-app-metadata 0.1.0__tar.gz

django-app-metadata-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

django-app-metadata-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include MANIFEST.in
+include README.md
+include requirements.txt
+graft django_app_metadata
+exclude django_app_metadata_demo
+exclude django_app_metadata_example
+global-exclude __pycache__
+global-exclude *.py[co]

django-app-metadata-0.1.0/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.1
+Name: django-app-metadata
+Version: 0.1.0
+Summary: Django数据字典管理应用。
+Author: rRR0VrFP
+Maintainer: rRR0VrFP
+License: Apache License, Version 2.0
+Keywords: django-app-metadata,django
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# django-app-metadata
+
+Django数据字典管理应用。
+
+## 安装
+
+```shell
+pip install django-app-metadata
+```
+
+## 使用
+
+*app/views.py*
+
+```python
+from django_app_metadata.models import Config
+
+def get_config(request):
+    key = reqeust.GET.get("key")
+    value = Config.get(key, default=None, default_published=True, frontend_flag=True)
+    return value
+```
+
+## 版本记录
+
+### v0.1.0
+
+- 版本首发。
+- 数据字典管理。
+- 数据字典获取支持缓存。

django-app-metadata-0.1.0/README.md

@@ -0,0 +1,30 @@
+# django-app-metadata
+
+Django数据字典管理应用。
+
+## 安装
+
+```shell
+pip install django-app-metadata
+```
+
+## 使用
+
+*app/views.py*
+
+```python
+from django_app_metadata.models import Config
+
+def get_config(request):
+    key = reqeust.GET.get("key")
+    value = Config.get(key, default=None, default_published=True, frontend_flag=True)
+    return value
+```
+
+## 版本记录
+
+### v0.1.0
+
+- 版本首发。
+- 数据字典管理。
+- 数据字典获取支持缓存。

django-app-metadata-0.1.0/django_app_metadata/__init__.py

@@ -0,0 +1,10 @@
+app_requires = [
+    "import_export",
+    "django_model_helper",
+    "django_safe_fields",
+    "django_data_history",
+]
+
+SAVE_DATA_HISTORIES_FOR = [
+    "django_app_metadata.config",
+]

django-app-metadata-0.1.0/django_app_metadata/admin.py

@@ -0,0 +1,102 @@
+from django.contrib import admin
+from import_export.admin import ImportExportModelAdmin
+from .models import Category
+from .models import Config
+
+
+class CategoryAdmin(admin.ModelAdmin):
+    list_display = [
+        "title",
+        "display_order",
+    ]
+    search_fields = [
+        "title",
+    ]
+    list_editable = [
+        "display_order",
+    ]
+    readonly_fields = [
+        "add_time",
+        "mod_time",
+    ]
+    fieldsets = [
+        (
+            None,
+            {
+                "fields": ["title", "display_order"],
+            },
+        )
+    ]
+
+
+class ConfigAdmin(ImportExportModelAdmin, admin.ModelAdmin):
+    list_display = [
+        "key",
+        "description",
+        "category",
+        "published",
+        "enabled",
+        "deleted",
+        "is_valid",
+        "enabled",
+    ]
+    list_filter = [
+        "is_valid",
+        "published",
+        "enabled",
+        "deleted",
+        "category",
+    ]
+    search_fields = [
+        "key",
+        "description",
+        "data_raw",
+    ]
+    fieldsets = [
+        (
+            "基础信息",
+            {
+                "fields": [
+                    "category",
+                    "key",
+                    "description",
+                    "type",
+                    "is_valid",
+                    "data_raw",
+                    "enabled",
+                    "published",
+                ]
+            },
+        ),
+        (
+            "其它信息",
+            {
+                "fields": [
+                    "add_time",
+                    "mod_time",
+                    "enabled_time",
+                    "disabled_time",
+                    "published_time",
+                    "unpublished_time",
+                    "deleted_time",
+                ]
+            },
+        ),
+    ]
+    readonly_fields = [
+        "add_time",
+        "mod_time",
+        "enabled_time",
+        "disabled_time",
+        "published_time",
+        "unpublished_time",
+        "deleted_time",
+        "is_valid",
+    ]
+    autocomplete_fields = [
+        "category",
+    ]
+
+
+admin.site.register(Config, ConfigAdmin)
+admin.site.register(Category, CategoryAdmin)

django-app-metadata-0.1.0/django_app_metadata/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class DjangoAppConfigConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "django_app_metadata"
+    verbose_name = "数据字典管理"

django-app-metadata-0.1.0/django_app_metadata/exceptions.py

@@ -0,0 +1,2 @@
+class AccessToUnpublishedConfigIsForbidden(RuntimeError):
+    pass

django-app-metadata-0.1.0/django_app_metadata/migrations/0001_initial.py

@@ -0,0 +1,165 @@
+# Generated by Django 4.2.17 on 2024-12-23 07:36
+
+from django.db import migrations, models
+import django.db.models.deletion
+import django_safe_fields.fields
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="Category",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "add_time",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="添加时间"
+                    ),
+                ),
+                (
+                    "mod_time",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="修改时间"
+                    ),
+                ),
+                (
+                    "display_order",
+                    models.IntegerField(blank=True, null=True, verbose_name="显示排序"),
+                ),
+                ("title", models.CharField(max_length=64, verbose_name="名称")),
+            ],
+            options={
+                "verbose_name": "配置项分类",
+                "verbose_name_plural": "配置项分类",
+            },
+        ),
+        migrations.CreateModel(
+            name="Config",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "add_time",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="添加时间"
+                    ),
+                ),
+                (
+                    "mod_time",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="修改时间"
+                    ),
+                ),
+                ("enabled", models.BooleanField(null=True, verbose_name="启用")),
+                (
+                    "enabled_time",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="启用时间"
+                    ),
+                ),
+                (
+                    "disabled_time",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="禁用时间"
+                    ),
+                ),
+                (
+                    "deleted",
+                    models.BooleanField(default=False, verbose_name="是否已删除"),
+                ),
+                (
+                    "deleted_time",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="删除时间"
+                    ),
+                ),
+                ("published", models.BooleanField(null=True, verbose_name="发布")),
+                (
+                    "published_time",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="发布时间"
+                    ),
+                ),
+                (
+                    "unpublished_time",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="收回时间"
+                    ),
+                ),
+                ("key", models.CharField(max_length=64, verbose_name="配置项标识")),
+                (
+                    "description",
+                    models.CharField(
+                        blank=True, max_length=64, null=True, verbose_name="配置项说明"
+                    ),
+                ),
+                (
+                    "type",
+                    models.IntegerField(
+                        choices=[
+                            (10, "YAML格式"),
+                            (20, "JSON格式"),
+                            (30, "字符串"),
+                            (40, "数值型"),
+                        ],
+                        default=10,
+                        verbose_name="内容数据类型",
+                    ),
+                ),
+                (
+                    "data_raw",
+                    django_safe_fields.fields.SafeTextField(
+                        blank=True,
+                        help_text="如果设置的值与指定的类型不匹配，将视为NULL。",
+                        null=True,
+                        verbose_name="配置项数据",
+                    ),
+                ),
+                (
+                    "is_valid",
+                    models.BooleanField(
+                        editable=False,
+                        help_text="这里显示的是上一次保存时的数据解析结果。保存时会更新更新该字段。",
+                        null=True,
+                        verbose_name="数据解析是否正确",
+                    ),
+                ),
+                (
+                    "category",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        to="django_app_metadata.category",
+                        verbose_name="分类",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "配置项",
+                "verbose_name_plural": "配置项",
+                "permissions": [("can_export_configs", "允许导出配置项")],
+            },
+        ),
+    ]

django-app-metadata-0.1.0/django_app_metadata/migrations/0002_alter_config_key.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.17 on 2024-12-23 07:41
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("django_app_metadata", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="config",
+            name="key",
+            field=models.CharField(
+                max_length=64, unique=True, verbose_name="配置项标识"
+            ),
+        ),
+    ]

django-app-metadata-0.1.0/django_app_metadata/models.py

@@ -0,0 +1,311 @@
+import logging
+import yaml
+import json
+from zenutils import typingutils
+from zenutils import jsonutils
+from null_object import Null
+
+from django.db import models
+from django.db.models.signals import post_save
+from django.db.models.signals import pre_save
+from django.db.models.signals import post_delete
+from django.dispatch import receiver
+from django.core.cache import caches
+
+from django_safe_fields.fields import SafeTextField
+from django_model_helper.models import WithAddModTimeFields
+from django_model_helper.models import WithEnabledStatusFields
+from django_model_helper.models import WithDeletedStatusFields
+from django_model_helper.models import WithDisplayOrderFields
+from django_model_helper.models import WithPublishStatusFields
+
+from .exceptions import AccessToUnpublishedConfigIsForbidden
+from .settings import DJANGO_APP_METADATA_USE_CACHE
+from .settings import DJANGO_APP_METADATA_CACHE_TIMEOUT
+from .settings import DJANGO_APP_METADATA_MISSING_CONFIG_CACHE_TIMEOUT
+from .settings import DJANGO_APP_METADATA_CACHE_NAME
+from .settings import DJANGO_APP_METADATA_CACHE_KEY_TEMPLATE
+
+_logger = logging.getLogger(__name__)
+
+
+class Category(
+    WithAddModTimeFields,
+    WithDisplayOrderFields,
+):
+    title = models.CharField(
+        max_length=64,
+        verbose_name="名称",
+    )
+
+    class Meta:
+        verbose_name = "配置项分类"
+        verbose_name_plural = "配置项分类"
+
+    def __str__(self):
+        return self.title
+
+
+class ConfigManager(models.Manager):
+    pass
+
+
+class ConfigQuerySet(models.QuerySet):
+    def bulk_update(self, objs, fields, batch_size=None):
+        # 对配置项执行bulk_update时需要删除所有key值对应的缓存
+        cache = caches[DJANGO_APP_METADATA_CACHE_NAME]
+        for obj in objs:
+            cache_key = DJANGO_APP_METADATA_CACHE_KEY_TEMPLATE.format(key=obj.key)
+            cache.delete(cache_key)
+            _logger.debug(
+                "config_bulk_update_delete_cache_key: id=%s, key=%s, cache_key=%s",
+                obj.id,
+                obj.key,
+                cache_key,
+            )
+        # 如果key值也参与了批量更新
+        # 需要查找出所有旧的key值并删除对应的缓存
+        if "key" in fields:
+            obj_ids = [obj.id for obj in objs]
+            old_objs = Config.objects.filter(id__in=obj_ids)
+            for obj in old_objs:
+                cache_key = DJANGO_APP_METADATA_CACHE_KEY_TEMPLATE.format(key=obj.key)
+                cache.delete(cache_key)
+                _logger.debug(
+                    "config_bulk_update_delete_cache_key: id=%s, key=%s, cache_key=%s",
+                    obj.id,
+                    obj.key,
+                    cache_key,
+                )
+        return super().bulk_update(objs, fields, batch_size)
+
+    bulk_update.alters_data = True
+
+
+class Config(
+    WithAddModTimeFields,
+    WithEnabledStatusFields,
+    WithDeletedStatusFields,
+    WithPublishStatusFields,
+):
+    objects = ConfigManager.from_queryset(ConfigQuerySet)()
+
+    YAML = 10
+    JSON = 20
+    STRING = 30
+    NUMBER = 40
+    TYPE_CHOICES = [
+        (YAML, "YAML格式"),
+        (JSON, "JSON格式"),
+        (STRING, "字符串"),
+        (NUMBER, "数值型"),
+    ]
+    category = models.ForeignKey(
+        Category,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        verbose_name="分类",
+    )
+    key = models.CharField(
+        max_length=64,
+        unique=True,
+        verbose_name="配置项标识",
+    )
+    description = models.CharField(
+        max_length=64,
+        null=True,
+        blank=True,
+        verbose_name="配置项说明",
+    )
+    type = models.IntegerField(
+        choices=TYPE_CHOICES,
+        default=YAML,
+        verbose_name="内容数据类型",
+    )
+    data_raw = SafeTextField(
+        null=True,
+        blank=True,
+        verbose_name="配置项数据",
+        help_text="如果设置的值与指定的类型不匹配，将视为NULL。",
+    )
+    is_valid = models.BooleanField(
+        null=True,
+        verbose_name="数据解析是否正确",
+        editable=False,
+        help_text="这里显示的是上一次保存时的数据解析结果。保存时会更新更新该字段。",
+    )
+
+    class Meta:
+        verbose_name = "配置项"
+        verbose_name_plural = "配置项"
+        permissions = [
+            ("can_export_configs", "允许导出配置项"),
+        ]
+
+    def __str__(self):
+        return self.key
+
+    def save(self, *args, **kwargs):
+        self.is_valid = self.validate()
+        return super().save(*args, **kwargs)
+
+    def get_type_code(self):
+        return self.type
+
+    def parse_data_raw(self):
+        if not self.data_raw:
+            return None
+        if self.type == self.NUMBER:
+            return typingutils.cast_numeric(self.data_raw)
+        elif self.type == self.STRING:
+            return self.data_raw
+        elif self.type == self.JSON:
+            return json.loads(self.data_raw)
+        else:
+            return yaml.safe_load(self.data_raw)
+
+    def get_data(self):
+        try:
+            return self.parse_data_raw()
+        except Exception as error:
+            _logger.error(
+                "字典数据解析失败：key=%s, data_raw=%s, error=%s",
+                self.key,
+                self.data_raw,
+                error,
+            )
+            return None
+
+    def set_data(self, data):
+        if not data:
+            self.data_raw = None
+        if self.type == self.NUMBER:
+            self.data_raw = data
+        elif self.type == self.STRING:
+            self.data_raw = data
+        elif self.type == self.JSON:
+            self.data_raw = jsonutils.simple_json_dumps(data, ensure_ascii=False)
+        else:
+            self.data_raw = yaml.safe_dump(data)
+            self.type = self.YAML
+
+    data = property(get_data, set_data)
+
+    def info(self):
+        return {
+            "id": self.pk,
+            "key": self.key,
+            "data": self.data,
+            "published": self.published,
+        }
+
+    def validate(self):
+        try:
+            data = self.parse_data_raw()
+            return True
+        except:
+            return False
+
+    @classmethod
+    def get(
+        cls,
+        key,  # 配置项键名
+        default=None,  # 如果数据库未设置该配置项时，该配置项的默认值。
+        default_published=False,  # 如果数据库未设置该配置项时，该配置项的默认可访问性。
+        use_cache=None,  # 是否使用缓存
+        cache_timeout=None,  # 缓存超时时长
+        missing_config_cache_timeout=None,
+        frontend_flag=False,  # 是否前端查询
+    ):
+        if use_cache is None:
+            use_cache = DJANGO_APP_METADATA_USE_CACHE
+        if cache_timeout is None:
+            cache_timeout = DJANGO_APP_METADATA_CACHE_TIMEOUT
+        if missing_config_cache_timeout is None:
+            missing_config_cache_timeout = (
+                DJANGO_APP_METADATA_MISSING_CONFIG_CACHE_TIMEOUT
+            )
+
+        info = Null
+        if (info is Null) and use_cache:
+            if DJANGO_APP_METADATA_CACHE_NAME in caches:
+                cache = caches[DJANGO_APP_METADATA_CACHE_NAME]
+                cache_key = DJANGO_APP_METADATA_CACHE_KEY_TEMPLATE.format(key=key)
+                info = cache.get(cache_key, Null)
+
+        if info is Null:
+            try:
+                obj = cls.objects.get(key=key, enabled=True, deleted=False)
+                info = obj.info()
+            except cls.DoesNotExist:
+                obj = None
+                info = {
+                    "id": 0,
+                    "key": key,
+                    "data": default,
+                    "published": default_published,
+                }
+                cache_timeout = missing_config_cache_timeout
+            if use_cache:
+                if DJANGO_APP_METADATA_CACHE_NAME in caches:
+                    cache = caches[DJANGO_APP_METADATA_CACHE_NAME]
+                    cache_key = DJANGO_APP_METADATA_CACHE_KEY_TEMPLATE.format(key=key)
+                    cache.set(cache_key, value=info, timeout=cache_timeout)
+
+        if frontend_flag and (not info.get("published", False)):
+            raise AccessToUnpublishedConfigIsForbidden(403, "禁止访问未发布的配置项。")
+        return info.get("data", default)
+
+
+@receiver(signal=pre_save, sender=Config)
+def config_pre_save_to_delete_cache_key(*args, **kwargs):
+    # 保存前配置项前判断key值是否变化
+    # 如果有变化，则删除旧key对应的缓存
+    instance = kwargs.get("instance", None)
+    if instance and instance.id:
+        old_instance = Config.objects.get(id=instance.id)
+        if old_instance.key != instance.key:
+            cache = caches[DJANGO_APP_METADATA_CACHE_NAME]
+            cache_key = DJANGO_APP_METADATA_CACHE_KEY_TEMPLATE.format(
+                key=old_instance.key
+            )
+            cache.delete(cache_key)
+            _logger.debug(
+                "config_pre_save_to_delete_cache_key: id=%s, key=%s, cache_key=%s",
+                instance.id,
+                instance.key,
+                cache_key,
+            )
+
+
+@receiver(signal=post_save, sender=Config)
+def config_post_save_to_delete_cache_key(*args, **kwargs):
+    # 保存配置项后删除key对应的缓存
+    instance = kwargs.get("instance", None)
+    if instance:
+        cache = caches[DJANGO_APP_METADATA_CACHE_NAME]
+        cache_key = DJANGO_APP_METADATA_CACHE_KEY_TEMPLATE.format(key=instance.key)
+        cache.delete(cache_key)
+        _logger.debug(
+            "config_post_save_to_delete_cache_key: id=%s, key=%s, cache_key=%s",
+            instance.id,
+            instance.key,
+            cache_key,
+        )
+
+
+@receiver(signal=post_delete, sender=Config)
+def config_post_delete_to_delete_cache_key(*args, **kwargs):
+    # 删除配置项后删除key对应的缓存
+    instance = kwargs.get("instance", None)
+    if instance:
+        cache = caches[DJANGO_APP_METADATA_CACHE_NAME]
+        cache_key = DJANGO_APP_METADATA_CACHE_KEY_TEMPLATE.format(key=instance.key)
+        cache.delete(cache_key)
+        _logger.debug(
+            "config_post_delete_to_delete_cache_key: id=%s, key=%s, cache_key=%s",
+            instance.id,
+            instance.key,
+            cache_key,
+        )

django-app-metadata-0.1.0/django_app_metadata/settings.py

@@ -0,0 +1,32 @@
+from django.conf import settings
+
+# 是否启用缓存。默认：启用。
+DJANGO_APP_METADATA_USE_CACHE = getattr(
+    settings,
+    "DJANGO_APP_METADATA_USE_CACHE",
+    True,
+)
+# 缓存时长。默认：1小时。
+DJANGO_APP_METADATA_CACHE_TIMEOUT = getattr(
+    settings,
+    "DJANGO_APP_METADATA_CACHE_TIMEOUT",
+    60 * 60,
+)
+# 缺失配置项缓存时长。默认：5分钟。
+DJANGO_APP_METADATA_MISSING_CONFIG_CACHE_TIMEOUT = getattr(
+    settings,
+    "DJANGO_APP_METADATA_MISSING_CONFIG_CACHE_TIMEOUT",
+    5 * 60,
+)
+# 缓存数据库名称。默认为：default。
+DJANGO_APP_METADATA_CACHE_NAME = getattr(
+    settings,
+    "DJANGO_APP_METADATA_CACHE_NAME",
+    "default",
+)
+# 缓存项模板。默认为："django_app_metadata_cache:{key}"
+DJANGO_APP_METADATA_CACHE_KEY_TEMPLATE = getattr(
+    settings,
+    "DJANGO_APP_METADATA_CACHE_KEY_TEMPLATE",
+    "django_app_metadata_cache:{key}",
+)

django-app-metadata-0.1.0/django_app_metadata/version.py

@@ -0,0 +1 @@
+VERSION = "0.1.0"

django-app-metadata-0.1.0/django_app_metadata/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

django-app-metadata-0.1.0/django_app_metadata.egg-info/PKG-INFO

@@ -0,0 +1,47 @@
+Metadata-Version: 2.1
+Name: django-app-metadata
+Version: 0.1.0
+Summary: Django数据字典管理应用。
+Author: rRR0VrFP
+Maintainer: rRR0VrFP
+License: Apache License, Version 2.0
+Keywords: django-app-metadata,django
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# django-app-metadata
+
+Django数据字典管理应用。
+
+## 安装
+
+```shell
+pip install django-app-metadata
+```
+
+## 使用
+
+*app/views.py*
+
+```python
+from django_app_metadata.models import Config
+
+def get_config(request):
+    key = reqeust.GET.get("key")
+    value = Config.get(key, default=None, default_published=True, frontend_flag=True)
+    return value
+```
+
+## 版本记录
+
+### v0.1.0
+
+- 版本首发。
+- 数据字典管理。
+- 数据字典获取支持缓存。

django-app-metadata-0.1.0/django_app_metadata.egg-info/SOURCES.txt

@@ -0,0 +1,23 @@
+LICENSE
+MANIFEST.in
+README.md
+requirements.txt
+setup.py
+django_app_metadata/__init__.py
+django_app_metadata/admin.py
+django_app_metadata/apps.py
+django_app_metadata/exceptions.py
+django_app_metadata/models.py
+django_app_metadata/settings.py
+django_app_metadata/tests.py
+django_app_metadata/version.py
+django_app_metadata/views.py
+django_app_metadata.egg-info/PKG-INFO
+django_app_metadata.egg-info/SOURCES.txt
+django_app_metadata.egg-info/dependency_links.txt
+django_app_metadata.egg-info/not-zip-safe
+django_app_metadata.egg-info/requires.txt
+django_app_metadata.egg-info/top_level.txt
+django_app_metadata/migrations/0001_initial.py
+django_app_metadata/migrations/0002_alter_config_key.py
+django_app_metadata/migrations/__init__.py

django-app-metadata-0.1.0/django_app_metadata.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

django-app-metadata-0.1.0/django_app_metadata.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

django-app-metadata-0.1.0/django_app_metadata.egg-info/requires.txt

@@ -0,0 +1,5 @@
+django
+django-safe-fields
+zenutils
+null-object
+PyYAML

django-app-metadata-0.1.0/django_app_metadata.egg-info/top_level.txt

@@ -0,0 +1 @@
+django_app_metadata

django-app-metadata-0.1.0/requirements.txt

@@ -0,0 +1,5 @@
+django
+django-safe-fields
+zenutils
+null-object
+PyYAML

django-app-metadata-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

django-app-metadata-0.1.0/setup.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+import os
+from io import open
+from setuptools import setup
+from setuptools import find_packages
+from django_app_metadata import version
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+with open(os.path.join(here, "README.md"), "r", encoding="utf-8") as fobj:
+    long_description = fobj.read()
+
+with open(os.path.join(here, "requirements.txt"), "r", encoding="utf-8") as fobj:
+    requires = fobj.readlines()
+requires = [x.strip() for x in requires if x.strip()]
+
+
+setup(
+    name="django-app-metadata",
+    version=version.VERSION,
+    description="Django数据字典管理应用。",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author="rRR0VrFP",
+    maintainer="rRR0VrFP",
+    license="Apache License, Version 2.0",
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        "License :: OSI Approved :: Apache Software License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3 :: Only",
+    ],
+    keywords=["django-app-metadata", "django"],
+    install_requires=requires,
+    packages=find_packages(
+        ".",
+        exclude=[
+            "django_app_metadata_demo",
+            "django_app_metadata_example",
+            "django_app_metadata_example.migrations",
+        ],
+    ),
+    zip_safe=False,
+    include_package_data=True,
+)