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

Implement tables.get rpc endpoint #3612

Merged
merged 9 commits into from
Jun 5, 2024
Merged

Implement tables.get rpc endpoint #3612

merged 9 commits into from
Jun 5, 2024

Conversation

Anish9901
Copy link
Member

Fixes #3611

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@Anish9901 Anish9901 marked this pull request as draft June 4, 2024 16:48
@Anish9901 Anish9901 marked this pull request as ready for review June 4, 2024 17:24
@Anish9901 Anish9901 requested a review from mathemancer June 4, 2024 17:24
@Anish9901 Anish9901 added the pr-status: review A PR awaiting review label Jun 4, 2024
Base automatically changed from table_delete to develop June 5, 2024 06:10
Copy link
Contributor

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

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

I have either one change to request, or a choice you made that I need to have explained to me: Why use get_ rather than get in the RPC function?

  • It makes the docs a little wonky, and
  • Using the trailing underscore is typically reserved for situations where you want to avoid colliding with a keyword in python.

@rpc_method(name="tables.get")
@http_basic_auth_login_required
@handle_rpc_exceptions
def get_(*, table_oid: int, database_id: int, **kwargs) -> TableInfo:
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't understand why you went with get_ here. get isn't a keyword, is it?

Copy link
Member Author

Choose a reason for hiding this comment

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

You are right, I erroneously thought it was a keyword. I've changed it to get.

@handle_rpc_exceptions
def get_(*, table_oid: int, database_id: int, **kwargs) -> TableInfo:
"""
List information about a table for a schema. Exposed as `get_`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should be exposed as get regardless.

@mathemancer mathemancer assigned Anish9901 and unassigned mathemancer Jun 5, 2024
@mathemancer mathemancer added pr-status: revision A PR awaiting follow-up work from its author after review and removed pr-status: review A PR awaiting review labels Jun 5, 2024
@Anish9901 Anish9901 requested a review from mathemancer June 5, 2024 08:48
Copy link
Contributor

@mathemancer mathemancer left a comment

Choose a reason for hiding this comment

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

Okay, I think this is good to go once the tests pass.

@mathemancer mathemancer enabled auto-merge June 5, 2024 08:53
@mathemancer mathemancer added this pull request to the merge queue Jun 5, 2024
Merged via the queue into develop with commit 9e23db0 Jun 5, 2024
37 checks passed
@mathemancer mathemancer deleted the table_get branch June 5, 2024 09:41
@kgodey kgodey added this to the v0.2.0-testing.1 milestone Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: revision A PR awaiting follow-up work from its author after review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement tables.get RPC method
3 participants