doc: Add Python install notes to build-osx.md. #27728

evansmj commented at 3:12 PM on May 23, 2023: none

When installing Bitcoin Core on OSX, a new developer may run into a situation where the deploy dependencies pip3 install ds_store mac_alias may be installed to an incorrect version of Python on the machine. I had this issue and spent much time on it. I add clarifying notes to the documentation and a recommendation to use PyEnv, as test/functional/README.md recommends it.

I spent a lot of time on resolving my error NoModuleFoundError No module named 'ds_store' due to this, and adding these clarifying notes about it will help future developers avoid this situation.

DrahtBot commented at 3:12 PM on May 23, 2023: contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Reviews

See the guideline for information on the review process.

Type	Reviewers
Concept NACK	fanquake

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

DrahtBot added the label Docs on May 23, 2023

evansmj force-pushed on May 23, 2023

in doc/build-osx.md:158 in bd26836fa7 outdated

 152 | @@ -153,10 +153,14 @@ For more information on ZMQ, see: [zmq.md](zmq.md)
 153 |  #### Test Suite Dependencies
 154 |  
 155 |  There is an included test suite that is useful for testing code changes when developing.
 156 | -To run the test suite (recommended), you will need to have Python 3 installed:
 157 | +To run the test suite (recommended), you will need to have Python 3 installed.
 158 | +It is recommended to use PyEnv to manage your python installation.
 159 | +Set your global version to the version specified in `Bitcoin/gui/.python-version`.

fanquake commented at 4:46 PM on May 23, 2023:

Bitcoin/gui/ - This isn't a directory in our source code?

fanquake commented at 4:51 PM on May 23, 2023: member

When installing Bitcoin Core on OSX, a new developer may run into a situation where the deploy dependencies pip3 install ds_store mac_alias may be installed to an incorrect version of Python on the machine.

This sounds like a local issue with your own Python version/package management.

Concept NACK on changing this to install pyenv, and become more involved in regards to package installation. Note that this also isn't a change we'd make in isolation to the build docs for a single platform.

evansmj force-pushed on May 23, 2023

evansmj commented at 5:13 PM on May 23, 2023: none

When installing Bitcoin Core on OSX, a new developer may run into a situation where the deploy dependencies pip3 install ds_store mac_alias may be installed to an incorrect version of Python on the machine.

This sounds like a local issue with your own Python version/package management.

Concept NACK on changing this to install pyenv, and become more involved in regards to package installation. Note that this also isn't a change we'd make in isolation to the build docs for a single platform.

pyenv is recommended by the test code style guide in test/functional/README.md and .python-version is included in the repo which is used by it, so that was my reason to bring up pyenv earlier in the onboarding process. i can remove the direction to pyenv global since running pyenv install in the project dir should install the version specified in .python-version. Still Concept Nack?

- The oldest supported Python version is specified in [doc/dependencies.md](/doc/dependencies.md). Consider using [pyenv](https://github.com/pyenv/pyenv), which checks [.python-version](/.python-version), to prevent accidentally introducing modern syntax from an unsupported Python version.

Add Python install notes to build-osx.md. 360cd0a40c

evansmj force-pushed on May 23, 2023

fanquake commented at 12:41 PM on May 26, 2023: member

Still Concept Nack?

Yes. Developers are free to use pyenv if they want, but it's not a requirement. I'd also say that most developers are likely using a version of Python which is actually much newer, than our oldest supported version.

Also, note that the ds_store and mac_alias packages will be dropped entirely after #27099, so I think there is even less need to make these changes at this point.

evansmj closed this on May 26, 2023

evansmj deleted the branch on May 26, 2023

bitcoin locked this on May 25, 2024