database_prefix deprecation warning says "will be removed in DataJoint 2.3", but the setting is still present in 2.3.x

未关闭
#1,675 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 6 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
mysql, postgresql, python

调研方向

Read how-to/deploy-production.md and reference/configuration.md, then compare their database_prefix guidance with the warning emitted by Schema.activate() and the setting in DatabaseSettings. Decide which deprecation schedule the maintainers want before changing the warning or docs; the issue presents two alternatives. Done when the code and documentation agree and production guidance no longer presents the deprecated setting as a normal recommendation.

由索引模型根据 Issue 内容生成。

描述

bug

Summary

database.database_prefix has been deprecated since 2.2.1. When it is set, Schema.activate() warns:

DeprecationWarning: database_prefix is deprecated and will be removed in DataJoint 2.3. Use database.name to select a PostgreSQL database instead.

The 2.3 releases have shipped (up to 2.3.5), and the setting is still there. dj.config.database.database_prefix and the DJ_DATABASE_PREFIX environment variable are both still accepted, and the warning still names 2.3 as the removal release. No release note gives a different schedule.

The warning is the only place the library reads the value. It is never applied to schema names, so dj.Schema("subject") activates subject whether or not a prefix is set. Users only get a prefix by adding it to schema names in their own code.

The documentation repeats the outdated schedule:

  • how-to/deploy-production.md, "Use Database Prefixes": a "Deprecated in 2.2.1" note says database_prefix "will be removed in 2.3". The section below it still teaches setting the prefix and building schema names from it.
  • The same page also uses it in production examples: DJ_DATABASE_PREFIX=prod_ in the environment and container examples, a verification script that reports an error when database_prefix is unset, and the development/production summary table.
  • reference/configuration.md marks the setting as deprecated without a version.

Reproduction

Against any fresh schema on DataJoint 2.3.x:

import warnings
import datajoint as dj

dj.config.database.database_prefix = "myproject_"

warnings.simplefilter("always", DeprecationWarning)
schema = dj.Schema("prefix_check")   # activates the schema and emits the warning

@schema
class Subject(dj.Manual):
    definition = """
    subject_id : int32
    ---
    subject_name : varchar(64)
    weight : float64
    """

print(dj.__version__)                       # 2.3.x
print(dj.config.database.database_prefix)   # 'myproject_'  (setting still accepted)
print(schema.database)                      # 'prefix_check' (prefix not applied)

Output (shown on a 2.3.5 development build):

DeprecationWarning: database_prefix is deprecated and will be removed in DataJoint 2.3. Use database.name to select a PostgreSQL database instead.
2.3.5...
myproject_
prefix_check

Expected behavior

The warning should name a release that has not shipped yet, or not name one at all. The documentation should give the same schedule as the code, and production guides should not recommend a deprecated setting as a normal production setting.

Options

These are two ways to fix it, and this issue does not pick one.

  1. Remove it in 2.4 on a stated schedule. On master, change the warning to "will be removed in DataJoint 2.4" so 2.3.x users get an accurate notice. On next, remove the setting: the database_prefix field in DatabaseSettings, the DJ_DATABASE_PREFIX mapping, and the check in Schema.activate(). Record the removal in the 2.4 release notes. In the docs, replace the "Use Database Prefixes" section and the production examples with the recommended alternative, keeping in mind that database.name selects a PostgreSQL database and has no direct MySQL equivalent.
  2. Correct the message and keep the setting for now. Change the warning to say the setting is deprecated and will be removed in a future release, or name a release once one is agreed. Make the docs say the same thing, and remove database_prefix from the production checklist, the example environments, and the summary table so the docs no longer recommend it.

With either option, the deprecation note in how-to/deploy-production.md and the entry in reference/configuration.md should match whatever the code says.

主要语言
Python
星标
198
派生
103
平均合并
6 天 1 小时
30 天内合并 PR
10

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

datajoint/datajoint-python 的其他 Issue

查看 datajoint/datajoint-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。