ENH: Adding pd.__git_version__ to point to git sha commit (#21295) #21680

atulagrwl · 2018-06-29T13:35:31Z

closes access git revision of currently running pandas #21295
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

jreback · 2018-06-29T13:58:21Z

pandas/__init__.py

@@ -83,6 +83,7 @@
 from ._version import get_versions
 v = get_versions()
 __version__ = v.get('closest-tag', v['version'])
+__git_version__ = v['full-revisionid']


this won’t work for released version
use .get

pls add a test for this

Adding test to check if it returns valid sha should be okay?

codecov · 2018-06-30T02:30:51Z

Codecov Report

Merging #21680 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #21680   +/-   ##
=======================================
  Coverage   92.05%   92.05%           
=======================================
  Files         170      170           
  Lines       50708    50708           
=======================================
  Hits        46677    46677           
  Misses       4031     4031

Flag	Coverage Δ
#multiple	`90.45% <ø> (ø)`	⬆️
#single	`42.36% <ø> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7a2fbce...9421725. Read the comment docs.

jreback · 2018-07-01T15:14:51Z

we have a once a day CI - https://github.com/pandas-dev/pandas-ci
that does a full install via pip and conda and then runs tests like a user
i believe this will fail here (these are post merge tests)

as git_version would be None

can u verify?

jreback

pls add a release note in 0.24 other enhancements

jreback · 2018-07-01T15:16:00Z

pandas/tests/test_common.py

+
+
+def test_git_version():
+    git_version = pd.__git_version__


can u add the issue number here

…ev#21295)

pep8speaks · 2018-07-01T17:10:41Z

Hello @atulagrwl! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on July 27, 2018 at 01:32 Hours UTC

atulaggarwal · 2018-07-01T17:15:43Z

we have a once a day CI - https://github.com/pandas-dev/pandas-ci
that does a full install via pip and conda and then runs tests like a user
i believe this will fail here (these are post merge tests)

I am not sure how to do that. This is my first commit to pandas and would appreciate if you tell me help me.

# Conflicts: # doc/source/whatsnew/v0.24.0.txt

atulagrwl · 2018-07-09T15:11:45Z

Merged latest master to resolve conflict in whatsnew file.

jbrockmendel · 2018-07-26T19:26:10Z

pandas/tests/test_common.py

@@ -262,3 +264,10 @@ def test_compression_warning(compression_only):
                                        check_stacklevel=False):
            with f:
                df.to_csv(f, compression=compression_only)
+
+
+# GH 21295


Nit: Pls put comment below def line.

jbrockmendel · 2018-07-26T19:26:53Z

@atulagrwl one more rebase, almost over the finish line.

…t_version

…ndas-dev#21295)

atulagrwl · 2018-07-26T20:00:48Z

@jbrockmendel - Did the rebase and minor refactoring as suggested in test.

jbrockmendel · 2018-07-27T00:09:22Z

doc/source/whatsnew/v0.24.0.txt

@@ -180,6 +180,8 @@ Other Enhancements
 - :func:`~DataFrame.to_csv` and :func:`~DataFrame.to_json` now support ``compression='infer'`` to infer compression based on filename (:issue:`15008`)
 - :func:`to_timedelta` now supports iso-formated timedelta strings (:issue:`21877`)
 - :class:`Series` and :class:`DataFrame` now support :class:`Iterable` in constructor (:issue:`2193`)
+- New method :meth:`__git_version__` will return git commit sha of current build


This is an attribute, not a method, right?

jbrockmendel · 2018-07-27T15:24:47Z

@jreback looks about right.

jreback · 2018-07-28T14:26:33Z

pandas/tests/test_common.py

+
+def test_git_version():
+    # GH 21295
+    git_version = pd.__git_version__


This will fail when built (which we test on pandas-ci), as the git_version will be None.

does this actually run when pandas is installed after tagging?
iow need to tag (locally) then build a release and install and pd.test()

Looks like it will, I ran:
python setup.py bdist_wheel
and installed that wheel in a fresh virtual env.
pd.__git_version__ then return the git sha of commit

jreback · 2018-07-28T14:28:21Z

pandas/__init__.py

@@ -83,6 +83,7 @@
 from ._version import get_versions
 v = get_versions()
 __version__ = v.get('closest-tag', v['version'])
+__git_version__ = v.get('full-revisionid')


is this what dask does? this will be None in the built version I think

Is there a way I can create a built version locally and test it out? @jreback

python setup.py bdist_wheel, and then install that wheel in a new env.

Created wheel from above command (https://www.dropbox.com/s/3ieyl07ctcsja9u/pandas-0.24.0.dev0%2B373.g942172546-cp36-cp36m-macosx_10_7_x86_64.whl?dl=0) and it showed git_version correctly

>>> import pandas as pd >>> pd.__version__ '0.24.0.dev0+373.g942172546' >>> pd.__git_version__ '9421725461061b55bc84e388d3952957d9b0cd83'

jreback · 2018-08-22T12:32:13Z

doc/source/whatsnew/v0.24.0.txt

@@ -180,6 +180,8 @@ Other Enhancements
 - :func:`~DataFrame.to_csv` and :func:`~DataFrame.to_json` now support ``compression='infer'`` to infer compression based on filename (:issue:`15008`)
 - :func:`to_timedelta` now supports iso-formated timedelta strings (:issue:`21877`)
 - :class:`Series` and :class:`DataFrame` now support :class:`Iterable` in constructor (:issue:`2193`)
+- New attribute :attr:`__git_version__` will return git commit sha of current build


add the issue ref here

alimcmaster1 · 2018-08-28T22:42:02Z

@atulagrwl this is almost there, mind merging in the latest changes to these files? And updating the issue ref as per @jreback comment.

alimcmaster1 · 2018-09-15T14:53:33Z

Im happy to take this over the line, since we haven't heard back from @atulagrwl . Will reopen a new PR and we can close this.

CC. @jangorecki

jschendel · 2018-09-18T19:35:29Z

Closing in favor of #22745

ENH: Adding pd.__git_version__ to point to git sha commit (pandas-dev…

bad820e

…#21295)

jreback requested changes Jun 29, 2018

View reviewed changes

ENH: Using .get instead of directly accessing (pandas-dev#21295)

94e9e41

atulagrwl added 2 commits June 30, 2018 08:03

ENH: Fixing typo in previous commit (pandas-dev#21295)

8a4563c

TST: Adding test for __git_version__ (pandas-dev#21295)

162985b

jreback requested changes Jul 1, 2018

View reviewed changes

pandas/tests/test_common.py Outdated

def test_git_version():

git_version = pd.__git_version__

Copy link

Contributor

jreback Jul 1, 2018

Choose a reason for hiding this comment

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

can u add the issue number here

TST: Adding whatsnews entry and adding issue number in test (pandas-d…

4808f52

…ev#21295)

TST: Fixing PEP8 error (pandas-dev#21295)

249d843

jreback added the Build Library building on various platforms label Jul 7, 2018

Merge branch 'master' into git_version

0406aa7

# Conflicts: # doc/source/whatsnew/v0.24.0.txt

jbrockmendel reviewed Jul 26, 2018

View reviewed changes

atulagrwl added 2 commits July 27, 2018 01:20

Merge branch 'master' of https://github.com/pandas-dev/pandas into gi…

756084a

…t_version

TST: Moving comment of Issue number below def as per review notes (pa…

a78165d

…ndas-dev#21295)

jbrockmendel reviewed Jul 27, 2018

View reviewed changes

Fixing whatsnew entry to specify attribute rather than method.

9421725

jreback requested changes Jul 28, 2018

View reviewed changes

jreback requested changes Aug 22, 2018

View reviewed changes

alimcmaster1 mentioned this pull request Sep 18, 2018

Git version #22745

Merged

jschendel closed this Sep 18, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENH: Adding pd.__git_version__ to point to git sha commit (#21295) #21680

ENH: Adding pd.__git_version__ to point to git sha commit (#21295) #21680

atulagrwl commented Jun 29, 2018

jreback Jun 29, 2018

atulagrwl Jun 30, 2018

codecov bot commented Jun 30, 2018 •

edited

Loading

jreback commented Jul 1, 2018

jreback left a comment

jreback Jul 1, 2018

pep8speaks commented Jul 1, 2018 •

edited

Loading

atulaggarwal commented Jul 1, 2018 •

edited

Loading

atulagrwl commented Jul 9, 2018

jbrockmendel Jul 26, 2018

jbrockmendel commented Jul 26, 2018

atulagrwl commented Jul 26, 2018

jbrockmendel Jul 27, 2018

jbrockmendel commented Jul 27, 2018

jreback Jul 28, 2018

jreback Sep 15, 2018

alimcmaster1 Sep 18, 2018 •

edited

Loading

jreback Jul 28, 2018

atulaggarwal Aug 21, 2018

TomAugspurger Aug 21, 2018

atulaggarwal Aug 21, 2018

jreback Aug 22, 2018

alimcmaster1 commented Aug 28, 2018

alimcmaster1 commented Sep 15, 2018

jschendel commented Sep 18, 2018

ENH: Adding pd.__git_version__ to point to git sha commit (#21295) #21680

ENH: Adding pd.__git_version__ to point to git sha commit (#21295) #21680

Conversation

atulagrwl commented Jun 29, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jun 30, 2018 • edited Loading

Codecov Report

jreback commented Jul 1, 2018

jreback left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pep8speaks commented Jul 1, 2018 • edited Loading

Comment last updated on July 27, 2018 at 01:32 Hours UTC

atulaggarwal commented Jul 1, 2018 • edited Loading

atulagrwl commented Jul 9, 2018

Choose a reason for hiding this comment

jbrockmendel commented Jul 26, 2018

atulagrwl commented Jul 26, 2018

Choose a reason for hiding this comment

jbrockmendel commented Jul 27, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alimcmaster1 Sep 18, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alimcmaster1 commented Aug 28, 2018

alimcmaster1 commented Sep 15, 2018

jschendel commented Sep 18, 2018

codecov bot commented Jun 30, 2018 •

edited

Loading

pep8speaks commented Jul 1, 2018 •

edited

Loading

atulaggarwal commented Jul 1, 2018 •

edited

Loading

alimcmaster1 Sep 18, 2018 •

edited

Loading