Skip to content

DOC: Add "build C extensions" note #46055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 27, 2022

Conversation

rendner
Copy link
Contributor

@rendner rendner commented Feb 18, 2022

This PR adds the missing information that the C extensions must be built when a local pandas repo was bind for the first time.

I also adjusted the docker commands to:

  • show how you can use your forked repo (--build-arg gh_username=yourname was missing)
  • specify the workdir -w /home/pandas, to directly start in the right directory

The C extensions must also be created when you bind your local repository for the first time.
@rendner rendner changed the title Add "build C extensions" note DOC: Add "build C extensions" note Feb 18, 2022
Copy link
Member

@rhshadrach rhshadrach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, minor request


python setup.py build_ext -j 4

You might need to rebuild the C extensions if/when you merge your repo with upstream/main.
Copy link
Member

@rhshadrach rhshadrach Feb 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You might need to rebuild the C extensions if/when you merge your repo with upstream/main.
You need to rebuild the C extensions anytime the Cython code in ``pandas/core/_libs`` changes. This most frequently occurs when changing or merging branches.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even better would be to separate out this into a new section, something like "Rebuilding the C extensions" and going into a bit more detail as to the why/how/when. But certainly okay to leave it here for this PR.

Copy link
Contributor Author

@rendner rendner Feb 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rhshadrach

  1. Is pandas/core/_libs right? Because such a folder does not exist. I think you mean pandas/_libs?

Even better would be to separate out this into a new section, something like "Rebuilding the C extensions"... But certainly okay to leave it here for this PR.

  1. That's a good idea. I can create a new issue if that is OK for you.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, an issue would be great.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, an issue would be great.

I created one.

@jreback jreback added this to the 1.5 milestone Feb 26, 2022
@jreback jreback added the Docs label Feb 26, 2022
@jreback jreback modified the milestones: 1.5, 1.4.2 Feb 26, 2022
@jreback
Copy link
Contributor

jreback commented Feb 26, 2022

looks ok @rhshadrach merge when ready

@rhshadrach rhshadrach merged commit 017a645 into pandas-dev:main Feb 27, 2022
@rhshadrach
Copy link
Member

Thanks @rendner!

meeseeksmachine pushed a commit to meeseeksmachine/pandas that referenced this pull request Feb 27, 2022
jreback pushed a commit that referenced this pull request Feb 27, 2022
Co-authored-by: Daniel Schmidt <rendner@users.noreply.github.com>
@rendner rendner deleted the docs-clarify-docker-env-setup branch March 2, 2022 19:36
yehoshuadimarsky pushed a commit to yehoshuadimarsky/pandas that referenced this pull request Jul 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

QST: [contributor question] how to run tests against local repo with Docker development environment
3 participants