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 件 担当者 0 名 GitHub で見る

メンテナーはふだん 6 日以内に返信

まだ誰も着手していません。

評価

難易度
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時間
マージ済み PR(30日)
10

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

datajoint/datajoint-python のほかの issue

datajoint/datajoint-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。