[ENH] Introduce xarray functionality into pyjanitor #585

zbarry · 2019-10-11T22:48:41Z

PR Description

Currently a proof-of-concept prototype of xarray functionality.

This PR resolves #586

PR Checklist

PR in from a fork off your branch. Do not PR from <your_username>:dev, but rather from <your_username>:<feature-branch_name>.

If you're not on the contributors list, add yourself to AUTHORS.rst.

Add a line to CHANGELOG.rst under the latest version header (i.e. the one that is "on deck") describing the contribution.
- Do use some discretion here; if there are multiple PRs that are related, keep them in a single line.

Code Changes

If you are adding code changes, please ensure the following:

Ensure that you have added tests.
Run all tests ($ pytest .) locally on your machine.
- Check to ensure that test coverage covers the lines of code that you have added.
- Ensure that all tests pass.

Documentation Changes

If you are adding documentation changes, please ensure the following:

Build the docs locally.
View the docs to check that it renders correctly.

Relevant Reviewers

Please tag maintainers to review.

codecov · 2019-10-11T22:54:08Z

Codecov Report

Merging #585 into dev will increase coverage by 1.27%.
The diff coverage is 99%.

@@            Coverage Diff            @@
##              dev    #585      +/-   ##
=========================================
+ Coverage   90.82%   92.1%   +1.27%     
=========================================
  Files          13      16       +3     
  Lines         436     519      +83     
=========================================
+ Hits          396     478      +82     
- Misses         40      41       +1

janitor/xarray/utils.py

* Reviewed and edited functional syntax examples. * Add bdice to AUTHORS. * Update changelog. * Fix examples of functional syntax in CONTRIBUTING.

* Add math module for chaining mathematical operations * Fixing docstring and imports for .math * Remove unnecessary imports from tests

…s length reasonable (#594)

* add dev requirements * update changelog * black; fix docstring * docstring * add data equivalence test * update docstring with semantic line breaks

* Fix contributions hyperlinks * Tag missing authors in `CHANGELOG.rst`

* Add pre-commit to dev env spec * add pre-commit * Pre-commit text file fixes * Added pre-commit hooks to install command * Add instructions on pre-commit hooks * add default -l 79 to black * fix environment yaml spec filename * add pre-commit to requirements-dev.txt

* Fix command formatting in CONTRIBUTING.rst * Add handle to CHANGELOG

zbarry · 2019-10-30T15:46:55Z

Besides moving to pandas-flavor for function registration, what do you all think would need to be done to push this through?

ericmjl · 2019-10-31T01:55:35Z

Nothing more, let's use an updated version of pandas-flavor so that we don't have to manage function registration. The starter functions look good. I'm going to look at codecov, and see what's causing the precipitous drop in code coverage.

ericmjl · 2019-10-31T02:11:24Z

OK, mostly it's about missing tests in the new functions. Let's make sure that the new functions are tested, and that they get included in the docs as well.

… accepted for column names (#610) * First commit for changing type hints for functions modules, except for functions that would be non-sensical as non-strings (e.g. _change_case, _camel2snake, _strip_accents) * Corrected docstrings to reflect type hint changes and make them more consistent between functions. * Design choice was made to have all new column names be enforced as strings to maximize compatibility, and to force string column names with "transform_columns" so that dictionary mapping may be retained. * Finished documentation correction for functions * Fixed bugs introduced into functions.flag_nulls * Fixed bugs introduced into convert_units (non-string column names make no sense if unit values in column names) and test_unionize_dataframe_categories. * Formatted & linted

* Added to changelog * Update CHANGELOG.rst Co-Authored-By: Eric Ma <ericmjl@users.noreply.github.com>

* Relaxed type hinting for chemistry module. * Relaxed type hinting for engineering module * Changed Union value in ml module to "Hashable" rather than any * Reformatted and linted * Fixed bugs introduced into convert_units * Added to changelog * Update CHANGELOG.rst Co-Authored-By: Eric Ma <ericmjl@users.noreply.github.com>

* bumpversion to 0.18.3 * removed isort, as it conflicts; only need to check black * pre-commit checks * maintenance: change CI system to use just "black" * maintenance: fixed execution of notebooks

zbarry · 2019-11-10T18:00:00Z

Good to look at now!

ericmjl

Just left my review! The number of changes looks intimidating, but really it's like 5-6 files that are substantially changed, so it's not so bad. Anybody else on the team would like to take a stab at reviewing the code? (tagging those who come to mind at this moment: @sallyhong @jk3587 @hectormz @szuckerman @eyaltrabelsi - no pressure, if you don't want to do anything, feel free to not comment back)

janitor/xarray/__init__.py

janitor/xarray/functions.py

janitor/xarray/utils.py

tests/xarray/conftest.py

tests/xarray/test_clone_using.py

zbarry · 2019-11-16T22:46:35Z

Should be good for a check now

ericmjl · 2019-11-17T02:42:13Z

Awesome stuff. I will cut 0.19.0 straight away.

proof-of-concept prototype of xarray functionality

8403380

zbarry added enhancement New feature or request help wanted Extra attention is needed good intermediate issue Issues that are good for seasoned programmers to make a contribution being worked on An individual has claimed this issue and would like to hack on it. labels Oct 11, 2019

zbarry mentioned this pull request Oct 11, 2019

[ENH] Implement framework for adding xarray methods #586

Closed

eyaltrabelsi reviewed Oct 12, 2019

View reviewed changes

janitor/xarray/utils.py Outdated Show resolved Hide resolved

bdice and others added 2 commits October 14, 2019 11:56

[DOC]: Reviewed and edited functional syntax examples. (#592)

ba4f038

* Reviewed and edited functional syntax examples. * Add bdice to AUTHORS. * Update changelog. * Fix examples of functional syntax in CONTRIBUTING.

[ENH] Add math module for chaining mathematical operations (#590)

a76a6d7

* Add math module for chaining mathematical operations * Fixing docstring and imports for .math * Remove unnecessary imports from tests

eyaltrabelsi mentioned this pull request Oct 16, 2019

Support extending xarray pyjanitor-devs/pandas_flavor#13

Closed

zbarry self-assigned this Oct 17, 2019

hectormz and others added 7 commits October 18, 2019 07:42

Move #noqa comment to end of docstrings to avoid docs pollution (#593)

e0213a3

[DOC] Split the CONTRIBUTING.rst file into 3 different rst to keep it…

9612d9a

…s length reasonable (#594)

add dev requirements

bc9d2a2

[ENH] Update list of dataframes' categoricals (#596)

117dd00

* add dev requirements * update changelog * black; fix docstring * docstring * add data equivalence test * update docstring with semantic line breaks

[DOC] Fix contributions hyperlinks and authors tags (#598)

38709e2

* Fix contributions hyperlinks * Tag missing authors in `CHANGELOG.rst`

[DOC] Fix command formatting in CONTRIBUTING.rst (#604)

248e634

* Fix command formatting in CONTRIBUTING.rst * Add handle to CHANGELOG

dendrondal and others added 8 commits November 2, 2019 10:14

[INF] Ensure that black and pycodestyle avoid venvs (#608)

17e4e1d

* Added to changelog * Update CHANGELOG.rst Co-Authored-By: Eric Ma <ericmjl@users.noreply.github.com>

Release Commit 0.18.3 #605 (#606)

f80d76c

* bumpversion to 0.18.3 * removed isort, as it conflicts; only need to check black * pre-commit checks * maintenance: change CI system to use just "black" * maintenance: fixed execution of notebooks

proof-of-concept prototype of xarray functionality

5ae5287

merge dev requirements

330bccc

merge requirements

90918af

implement clone_using tests

a9b89e9

zbarry added 4 commits November 10, 2019 12:31

reformat clone docstring

63efdc1

move fixture, add datetime test

a355699

move fixture, add datetime test

84f1086

add xarray docs

7914d04

zbarry removed the being worked on An individual has claimed this issue and would like to hack on it. label Nov 10, 2019

zbarry changed the title ~~[ENH] [WIP] introduce xarray functionality into pyjanitor~~ [ENH] Introduce xarray functionality into pyjanitor Nov 10, 2019

ericmjl requested changes Nov 10, 2019

View reviewed changes

zbarry added 7 commits November 10, 2019 15:39

missed an all() on test

3cbbcab

remove xarray accessor registration

d371231

add examples in docstrings

fac3c62

black formatting

a279a49

add docstring to dataarray fixture

6aaf98d

extend docstring

3163a70

remove trailing whitespace

d3db795

ericmjl approved these changes Nov 17, 2019

View reviewed changes

ericmjl merged commit bb6d113 into dev Nov 17, 2019

ericmjl deleted the xarray branch November 17, 2019 02:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ENH] Introduce xarray functionality into pyjanitor #585

[ENH] Introduce xarray functionality into pyjanitor #585

zbarry commented Oct 11, 2019 •

edited

Loading

codecov bot commented Oct 11, 2019 •

edited

Loading

zbarry commented Oct 30, 2019

ericmjl commented Oct 31, 2019

ericmjl commented Oct 31, 2019

zbarry commented Nov 10, 2019

ericmjl left a comment •

edited

Loading

zbarry commented Nov 16, 2019

ericmjl commented Nov 17, 2019

[ENH] Introduce xarray functionality into pyjanitor #585

[ENH] Introduce xarray functionality into pyjanitor #585

Conversation

zbarry commented Oct 11, 2019 • edited Loading

PR Description

PR Checklist

Code Changes

Documentation Changes

Relevant Reviewers

codecov bot commented Oct 11, 2019 • edited Loading

Codecov Report

zbarry commented Oct 30, 2019

ericmjl commented Oct 31, 2019

ericmjl commented Oct 31, 2019

zbarry commented Nov 10, 2019

ericmjl left a comment • edited Loading

Choose a reason for hiding this comment

zbarry commented Nov 16, 2019

ericmjl commented Nov 17, 2019

zbarry commented Oct 11, 2019 •

edited

Loading

codecov bot commented Oct 11, 2019 •

edited

Loading

ericmjl left a comment •

edited

Loading