ENH: fall back to platformdirs user_config_dir

untzag commented 1 year ago

Description

Add platformdirs dependency. platformdirs itself has no dependencies as far as I know, so don't worry about dependency chains.

Fall back to platformdirs.user_config_dir if happi cfg not found in XDG_CONFIG_HOME or .config.

Motivation and Context

Gives an additional sane default. Especially useful on workstations running Windows or MacOS. Especially machines that I don't control...

How Has This Been Tested?

It just looks in one additional place, I don't think we need tests... happy to add if maintainers request.

Where Has This Been Documented?

Pre-merge checklist

[x] Code works interactively
[x] Code contains descriptive docstrings, including context and API
[x] New/changed functions and methods are covered in the test suite where possible
[x] Test suite passes locally
[x] Test suite passes on GitHub Actions
[x] Ran docs/pre-release-notes.sh and created a pre-release documentation page
[x] Pre-release docs include context, functional descriptions, and contributors as appropriate

untzag commented 1 year ago

If someone has a clue about the 3.11 failures I'd appreciate any insight.

klauer commented 1 year ago

If someone has a clue about the 3.11 failures I'd appreciate any insight.

Don't worry about it - it's not required for merging. We noticed the failures when migrating to pyproject.toml (https://github.com/pcdshub/happi/pull/296) due to a dependency, line-profiler, and its incompatibilities with our Python version matrix. More details are in that PR, if you want to know more.

ZLLentz commented 1 year ago

I think this is :+1: I'm also surprised that appdirs is deprecated- it looks like it wasn't abandoned for a technical reason, but instead due to not having time to maintain it any more. This is speculation of course, but I think it's true considering the text in the readme:

Note: This project has been officially deprecated. You may want to check out https://pypi.org/project/platformdirs/ which is a more active fork of appdirs. Thanks to everyone who has used appdirs. Shout out to ActiveState for the time they gave their employees to work on this over the years.

Implying that it started at a company named ActiveState who eventually said "stop spending time on this"

pcdshub / happi