gh-73965: New environment variable PYTHON_HISTORY by ZackerySpytz · Pull Request #13208 · python/cpython

ZackerySpytz · 2019-05-08T19:17:02Z

It can be used to set the location of a .python_history file.

Co-Authored-By: Levi Sabah 0xl3vi@gmail.com

Issue: New environment variable PYTHON_HISTORY #73965

It can be used to set the location of a .python_history file. Co-Authored-By: Levi Sabah <0xl3vi@gmail.com>

pablogsal · 2019-05-10T17:43:14Z

 can be set to the callable of your debugger of choice.
+.IP PYTHONHISTORY
+This environment variable can be used to set the location of a history file
+(it is \fI~/.python_history\fP by default).


Please, add the windows default as well.

To be frank, I'm not sure if the Windows default should be mentioned in the man page...

There is nothing wrong with mentioning Windows ops in man pages.

tirkarthi · 2019-05-11T05:31:35Z

There are few other places in Docs where hardcoded value of ~/.python_history is referred to.

$ rg python_history Doc
Doc/tutorial/interactive.rst
28:history into a file named :file:`.python_history` in your user directory.
Doc/library/readline.rst
292:file named :file:`.python_history` from the user's home directory. The code
300: histfile = os.path.join(os.path.expanduser("~"), ".python_history")
319: histfile = os.path.join(os.path.expanduser("~"), ".python_history")
Doc/library/site.rst
135::file:`~/.python_history` as the history save file. To disable it, delete (or

ZackerySpytz · 2019-05-14T11:18:02Z

@tirkarthi The first three cases mention .python_history, not ~/.python_history, no?

The fourth case mentions ~/.python_history in the context of the readline
module, which is not available on Windows. So, I'm not sure if those parts of
the docs need to be modified.

ZackerySpytz · 2019-05-15T07:57:10Z

By the way, on Windows, os.path.expanduser("~") returns (for example) 'C:\\Users\\Tim'.

tiran

The new env var does not obey the sys.flags.ignore_environment flag. Please add a test that the new env var is ignored with -E or -I mode.

bedevere-bot · 2019-05-15T08:41:30Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

tiran · 2019-05-15T08:50:34Z

Could you please reword to explain what the history file actually does? It's non-obvious to users that are not familiar with readline module internals.

ZackerySpytz · 2019-05-19T12:22:51Z

I have made the requested changes; please review again.

bedevere-bot · 2019-05-19T12:22:53Z

Thanks for making the requested changes!

@tiran: please review the changes made to this pull request.

ZackerySpytz · 2019-05-19T12:23:24Z

Could you please reword to explain what the history file actually does?

Reword what?

…ISTORY-env-var

vszakats · 2019-08-28T21:53:50Z

Can this be merged? It seems fairly obvious what .python_history means and it'd be quite nice to be able to control where it goes.

EmilRehnberg · 2019-12-30T08:00:06Z

Thanks for this!

Please make sure there will be no problem with paths with subdirectories that might not be created. E.g. "export PYTHONHISTORY=$HOME/.cache/python/history please assert that the path will be created if missing.

wren · 2020-07-04T23:36:18Z

Any way to help get this through? It looks like it's been ready for a while.

warsaw · 2021-10-22T19:23:55Z

Looks like there are conflicts now which need to be resolved, and probably rebased.

eabase · 2022-01-24T01:35:13Z

Guys, why on earth are you hard-coding a commonly used and often changed file-path like this?

I was sincerely expecting to find an internal built-in variable named something like DEFAULT_HISTORY_FILE, but to my unpleasant surprise, I instead find history = os.path.join(os.path.expanduser('~'),'.python_history').

While at the same time being met with:

readline.write_history_file.__doc__# 'Save a readline history file. The default filename is ~/.history.'

hugovk

Please resolve the merge conflicts.

…ON_HISTORY-env-var

Dismissed stale review

hugovk · 2024-01-04T14:13:58Z

I've resolved conflicts, renamed to PYTHON_HISTORY and targeted 3.13.

hauntsaninja · 2024-01-07T06:29:53Z

Thanks Hugo!

serhiy-storchaka · 2024-01-07T09:39:13Z

 "PYTHON_COLORS : If this variable is set to 1, the interpreter will"
 " colorize various kinds of output. Setting it to 0 deactivates this behavior.\n"
 "These variables have equivalent command-line parameters (see --help for details):\n"
+"PYTHON_HISTORY: the location of a .python_history file.\n"


What command line parameter sets it?

It doesn't have one, I compared with PYTHON_COLORS which doesn't either (#112732). Should we add one?

If it doesn't have one, then it is in the wrong section.

Good point, please see PR #113798 to move it to the correct section.

It can be used to set the location of a .python_history file --------- Co-authored-by: Levi Sabah <0xl3vi@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

thanks to https://unix.stackexchange.com/questions/630642/change-location-of-python-history - don't use a new folder cause 1) no need for just 1 file 2) python won't make it for you, will just fail to write history. [`xdg-ninja`](https://github.com/b3nj5m1n/xdg-ninja) is good, we need more all-in-one places for doing config like this. but it's more or less just a community thing will need a place for these lines in zshrc /shrug + try some LSP servers + bat hard-wraps, less -S is nice

bpo-29779: New environment variable PYTHONHISTORY
a2ca22c
It can be used to set the location of a .python_history file. Co-Authored-By: Levi Sabah <0xl3vi@gmail.com>

the-knights-who-say-ni added the CLA signed label May 8, 2019

bedevere-bot added the awaiting review label May 8, 2019

pablogsal reviewed May 10, 2019
View reviewed changes

Comment threadDoc/using/cmdline.rst Outdated

pablogsal reviewed May 10, 2019
View reviewed changes

Comment threadLib/site.py Outdated

pablogsal reviewed May 10, 2019
View reviewed changes

Comment threadLib/site.py Outdated

pablogsal reviewed May 10, 2019
View reviewed changes

Address the review comments.
d13fd90

ZackerySpytz mentioned this pull request May 15, 2019
bpo-29779: new environment variable PYTHONHISTORY. #473
Closed

tiran previously requested changes May 15, 2019
View reviewed changes

bedevere-bot added awaiting changes and removed awaiting review labels May 15, 2019

tiran reviewed May 15, 2019
View reviewed changes

Comment threadLib/site.py

ZackerySpytz added 2 commits May 15, 2019 18:09

Account for sys.flags.ignore_environment.
9b7398c

Fix Travis.
fe6c760

bedevere-bot removed the awaiting changes label May 19, 2019

bedevere-bot added the awaiting change review label May 19, 2019

Merge remote-tracking branch 'upstream/master' into bpo-29779-PYTHONH…
4ddf85b
…ISTORY-env-var

jonathan-conder mentioned this pull request Nov 14, 2019
bpo-38791: Add readline history environment variable #17149
Closed

This was referenced Jan 24, 2022
gh-88405: Use platform defined data directories instead of ~/.python_history #26377
Open
2 different history filenames, which is right?- Probably neither pyreadline3/pyreadline3#4
Open

This comment was marked as abuse.
Sign in to view

ezio-melotti removed the CLA signed label Jul 13, 2022

njhanley mentioned this pull request Mar 5, 2023
Add environment variable to change REPL history file path denoland/deno#18010
Closed

hugovk reviewed Dec 26, 2023
View reviewed changes

hugovk changed the title ~~bpo-29779: New environment variable PYTHONHISTORY~~gh-73965: New environment variable PYTHON_HISTORYDec 26, 2023

0xl3vimannequin mentioned this pull request Apr 10, 2022
New environment variable PYTHON_HISTORY #73965
Closed

serhiy-storchaka self-requested a review December 26, 2023 11:28

hugovk added 2 commits January 4, 2024 14:07

Merge remote-tracking branch 'upstream/main' intopythongh-73965-PYTH…
d49c0ff
…ON_HISTORY-env-var

Rename to PYTHON_HISTORY and target 3.13
bc5b771

bedevere-appBot added awaiting review and removed awaiting change review labels Jan 4, 2024

hauntsaninja approved these changes Jan 7, 2024
View reviewed changes

bedevere-appBot added awaiting merge and removed awaiting review labels Jan 7, 2024

hauntsaninja merged commit f19b93f into python:mainJan 7, 2024

bedevere-appBot removed the awaiting merge label Jan 7, 2024

serhiy-storchaka reviewed Jan 7, 2024
View reviewed changes

hugovk mentioned this pull request Jan 7, 2024
gh-73965: Move PYTHON_HISTORY into the correct usage section #113798
Merged

Uh oh!

Uh oh!

Conversation

ZackerySpytz commented May 8, 2019• edited by hugovk Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pablogsalMay 10, 2019• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ZackerySpytzMay 14, 2019

Choose a reason for hiding this comment

Uh oh!

eabaseJan 25, 2022

Choose a reason for hiding this comment

Uh oh!

tirkarthi commented May 11, 2019

Uh oh!

ZackerySpytz commented May 14, 2019

Uh oh!

ZackerySpytz commented May 15, 2019

Uh oh!

tiran left a comment

Choose a reason for hiding this comment

Uh oh!

bedevere-bot commented May 15, 2019

Uh oh!

tiran commented May 15, 2019

Uh oh!

Uh oh!

ZackerySpytz commented May 19, 2019

Uh oh!

bedevere-bot commented May 19, 2019

Uh oh!

ZackerySpytz commented May 19, 2019

Uh oh!

vszakats commented Aug 28, 2019

Uh oh!

EmilRehnberg commented Dec 30, 2019

Uh oh!

wren commented Jul 4, 2020

Uh oh!

warsaw commented Oct 22, 2021

Uh oh!

eabase commented Jan 24, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as abuse.

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hugovk commented Jan 4, 2024

Uh oh!

hauntsaninja commented Jan 7, 2024

Uh oh!

serhiy-storchakaJan 7, 2024

Choose a reason for hiding this comment

Uh oh!

hugovkJan 7, 2024

Choose a reason for hiding this comment

Uh oh!

serhiy-storchakaJan 7, 2024

Choose a reason for hiding this comment

Uh oh!

hugovkJan 7, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

ZackerySpytz commented May 8, 2019•
edited by hugovk
Loading

pablogsalMay 10, 2019•
edited
Loading

eabase commented Jan 24, 2022•
edited
Loading