Skip to content
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

Fixed dfply documentation on verbs, created longs of those verbs, and improved dflpy import. #110

Merged
merged 8 commits into from
Jun 30, 2021

Conversation

OscarDeGar
Copy link
Collaborator

@OscarDeGar OscarDeGar commented Jun 17, 2021

Resolves #109
Resolves #9

Previously calling "help" command on dfply verbs did not produce any
useful documentation. This has been remedied and now will print
documentation on the verb as well as inherited pipe methods just like
the current other grama verbs do.
Another change was in doing so long versions were created of all dfply
verbs.
Import system in dfply update to reflect this but still needs work.
Unit-testing particular to long dfply verbs still needs to be implemented.
Dfply previously was being imported by individual lines for each need verb or tool.
Now each file has been udpdated to use the __all__ attribute in order to relative
import everything from dfply now on one line in the main __init__.py file
@OscarDeGar OscarDeGar changed the title Fixed dfply documentation on verbs, created longs of those verbs, and imporved dflpy import. Fixed dfply documentation on verbs, created longs of those verbs, and improved dflpy import. Jun 17, 2021
Copy link
Owner

@zdelrosario zdelrosario left a comment

Choose a reason for hiding this comment

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

Overall great improvement to the codebase! Requesting some small changes; I'm also going to try to get codecov working again so we can automatically check coverage....

"Pipe-enabled version of {}\n".format(fun.__name__)
+ "Inherited Signature: {}\n".format(signature(fun))
+ fun.__doc__
fun.__doc__
Copy link
Owner

Choose a reason for hiding this comment

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

This creates a new issue that we'll have to resolve....

Copy link
Owner

Choose a reason for hiding this comment

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

@OscarDeGar can you open a new Issue to track this? Last thing to fix before moving on....

grama/__init__.py Show resolved Hide resolved
grama/dfply/reshape.py Outdated Show resolved Hide resolved
grama/dfply/base.py Show resolved Hide resolved
grama/dfply/select.py Outdated Show resolved Hide resolved
grama/dfply/subset.py Outdated Show resolved Hide resolved
grama/dfply/summarize.py Outdated Show resolved Hide resolved
grama/dfply/summary_functions.py Outdated Show resolved Hide resolved
grama/dfply/vector.py Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Jun 29, 2021

Codecov Report

Merging #110 (3dff7b4) into master (61683aa) will increase coverage by 9.19%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #110      +/-   ##
==========================================
+ Coverage   89.80%   98.99%   +9.19%     
==========================================
  Files          80       27      -53     
  Lines        5393     1787    -3606     
==========================================
- Hits         4843     1769    -3074     
+ Misses        550       18     -532     
Impacted Files Coverage Δ
tests/test_dfply_join.py
tests/test_shapley.py
tests/test_dfply_subset.py
grama/eval/__init__.py
tests/test_dfply_summarize.py
tests/context.py
tests/test_autoplot.py
tests/test_models.py
tests/test_mp_restart.py
tests/test_string_helpers.py
... and 48 more

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 61683aa...3dff7b4. Read the comment docs.

import itertools

import grama as gr
from grama import add_pipe, pipe
Copy link
Owner

Choose a reason for hiding this comment

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

I'm curious what best-practices on this are: To import individual methods from the package, or target the source file in the project with that method?

Copy link
Owner

@zdelrosario zdelrosario left a comment

Choose a reason for hiding this comment

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

Nearly there! A couple more things to resolve; looks like you still have a couple full-Grama imports running around

grama/fit/fit_statsmodels.py Show resolved Hide resolved
grama/models/cantilever_beam.py Show resolved Hide resolved
grama/plot_auto.py Show resolved Hide resolved
grama/tools.py Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dfply import inefficient in main __init__.py dfply documentation
2 participants