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

feat: add ak_to_feather and ak_from_feather functions #2683

Merged
merged 22 commits into from
Sep 19, 2023

Conversation

zbilodea
Copy link
Collaborator

No description provided.

@jpivarski
Copy link
Member

Hi!

@codecov
Copy link

codecov bot commented Aug 31, 2023

Codecov Report

Merging #2683 (4dba6e2) into main (4124889) will increase coverage by 0.00%.
The diff coverage is 88.57%.

Additional details and impacted files
Files Changed Coverage Δ
src/awkward/operations/ak_to_feather.py 82.60% <82.60%> (ø)
src/awkward/operations/__init__.py 100.00% <100.00%> (ø)
src/awkward/operations/ak_from_feather.py 100.00% <100.00%> (ø)

@pre-commit-ci pre-commit-ci bot temporarily deployed to docs-preview August 31, 2023 16:00 Inactive
@zbilodea zbilodea requested review from jpivarski and removed request for jpivarski August 31, 2023 16:16
@zbilodea zbilodea temporarily deployed to docs-preview August 31, 2023 16:23 — with GitHub Actions Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to docs-preview September 6, 2023 17:52 Inactive
@zbilodea zbilodea temporarily deployed to docs-preview September 6, 2023 18:30 — with GitHub Actions Inactive
@zbilodea zbilodea temporarily deployed to docs-preview September 7, 2023 15:55 — with GitHub Actions Inactive
@jpivarski jpivarski temporarily deployed to docs-preview September 7, 2023 16:15 — with GitHub Actions Inactive
@jpivarski jpivarski temporarily deployed to docs-preview September 7, 2023 16:40 — with GitHub Actions Inactive
@jpivarski
Copy link
Member

When you're ready (when the docstrings are done and you've done "Update branch" with no errors), do "Ready for review" and assign me as the reviewer.

@jpivarski
Copy link
Member

Oh, I just remembered something: we want the new functions to show up in the documentation, too. They need to be added to the right sections of docs/reference/toctree.txt, and then they'll show up when you press the "View deployment" button, followed by "API reference", in the left side-bar.

@zbilodea zbilodea temporarily deployed to docs-preview September 8, 2023 18:45 — with GitHub Actions Inactive
@zbilodea zbilodea temporarily deployed to docs-preview September 8, 2023 19:05 — with GitHub Actions Inactive
@zbilodea zbilodea temporarily deployed to docs-preview September 8, 2023 19:42 — with GitHub Actions Inactive
@zbilodea zbilodea temporarily deployed to docs-preview September 8, 2023 21:33 — with GitHub Actions Inactive
@zbilodea zbilodea temporarily deployed to docs-preview September 9, 2023 01:17 — with GitHub Actions Inactive
@zbilodea zbilodea marked this pull request as ready for review September 11, 2023 13:40
Copy link
Member

@jpivarski jpivarski left a comment

Choose a reason for hiding this comment

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

Nice! Just a few twisted changes, mostly described below.

Did you see the generated documentation? In the last "View Deployment" button, the documentation for the two functions are rendered at

http://preview.awkward-array.org.s3-website.us-east-1.amazonaws.com/zbilodea/add-feather/reference/generated/ak.from_feather.html

and

http://preview.awkward-array.org.s3-website.us-east-1.amazonaws.com/zbilodea/add-feather/reference/generated/ak.to_feather.html

src/awkward/operations/ak_from_feather.py Outdated Show resolved Hide resolved
src/awkward/operations/ak_from_feather.py Outdated Show resolved Hide resolved
src/awkward/operations/ak_to_feather.py Show resolved Hide resolved
src/awkward/operations/ak_to_feather.py Outdated Show resolved Hide resolved
@zbilodea zbilodea temporarily deployed to docs-preview September 13, 2023 12:19 — with GitHub Actions Inactive
@zbilodea zbilodea temporarily deployed to docs-preview September 18, 2023 09:47 — with GitHub Actions Inactive
feather_version=2,
version=2,
Copy link
Member

Choose a reason for hiding this comment

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

I think it's good for this to be called feather_version, since it would be ambiguous what the "version" is referring to otherwise.

Copy link
Member

@jpivarski jpivarski left a comment

Choose a reason for hiding this comment

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

Great, thanks! I just made a few small changes before merging because they'd be easier to apply than to describe.

I'll give you a chance to make counter-edits, but I think this is ready to squash-and-merge.

@jpivarski jpivarski temporarily deployed to docs-preview September 18, 2023 19:17 — with GitHub Actions Inactive
@jpivarski jpivarski enabled auto-merge (squash) September 19, 2023 02:18
@jpivarski jpivarski temporarily deployed to docs-preview September 19, 2023 03:09 — with GitHub Actions Inactive
@jpivarski jpivarski merged commit 4d9ffc5 into main Sep 19, 2023
37 checks passed
@jpivarski jpivarski deleted the zbilodea/add-feather branch September 19, 2023 03:12
@jpivarski
Copy link
Member

@all-contributors please add @zbilodea for code

Copy link
Contributor

@jpivarski

I've put up a pull request to add @zbilodea! 🎉

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.

ak.to_feather/ak.from_feather in analogy with ak.to_parquet/ak.from_parquet
2 participants