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

Add generic ptr.To, ptr.Deref, ptr.Equal #283

Merged
merged 1 commit into from
Jul 26, 2023

Conversation

skitt
Copy link
Member

@skitt skitt commented Jun 15, 2023

What type of PR is this?

/kind feature

What this PR does / why we need it:

This adds a ptr package containing generic equivalents of the pointer functions: ptr.To, ptr.Deref and ptr.Equal. This simplifies the implementation and adds support for pointers to enums and arbitrary types.

To allow a complete migration from pointer to ptr, this also moves AllPtrFieldsNil. The ptr.AllPtrFieldsNil "ptr" repetition is preserved since the function only looks at pointer fields.

Existing deprecation notices are updated to point to the new functions, and the pointer package as a whole is deprecated. Existing test code is preserved as-is to "prove" the correctness of the migration.

This was mostly written by @alculquicondor ; see #269 for context.

Which issue(s) this PR fixes:

Special notes for your reviewer:

Release note:

Added ptr.To, ptr.Deref and ptr.Equal to handle pointers generically, replacing the pointer functions in the pointer package.

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 15, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @skitt!

It looks like this is your first PR to kubernetes/utils 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/utils has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 15, 2023
Copy link
Member

@alculquicondor alculquicondor left a comment

Choose a reason for hiding this comment

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

LGTM

pointer/pointer.go Show resolved Hide resolved
This simplifies the implementation and adds support for pointers to
enums and arbitrary types.

To allow a complete migration from pointer to ptr, this also moves
AllPtrFieldsNil. The ptr.AllPtrFieldsNil "ptr" repetition is preserved
since the function only looks at pointer fields.

Existing deprecation notices are updated to point to the new
functions, and the pointer package as a whole is deprecated.
Existing test code is preserved as-is to "prove" the correctness of
the migration.

This was mostly written by Aldo Culquicondor; see
kubernetes#269 for context.

Signed-off-by: Stephen Kitt <skitt@redhat.com>
Copy link
Member

@alculquicondor alculquicondor left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 16, 2023
@skitt
Copy link
Member Author

skitt commented Jun 16, 2023

/assign @mengqiy
/cc @thockin

@skitt
Copy link
Member Author

skitt commented Jun 16, 2023

/hold
until 2023-07-28 (1.24 EOL)

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 16, 2023
Copy link
Member

@thockin thockin left a comment

Choose a reason for hiding this comment

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

Thanks!

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alculquicondor, skitt, thockin

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 14, 2023
@alculquicondor
Copy link
Member

/hold cancel

The last 1.24 patch was released.

@liyuerich
Copy link

@skitt could you mind I also work on "ptr.Deref" followed this PR ? any question please let me know, thanks.

@skitt
Copy link
Member Author

skitt commented Sep 12, 2023

@skitt could you mind I also work on "ptr.Deref" followed this PR ? any question please let me know, thanks.

Please, go ahead! I’ve pushed all my pending changes, and I haven’t addressed ptr.Deref at all. Thanks!

@Rei1010
Copy link

Rei1010 commented Sep 13, 2023

@skitt I'd like to work on "ptr.Equal"

liangyuanpeng added a commit to liangyuanpeng/kubernetes that referenced this pull request Apr 15, 2024
The new k8s.io/utils/ptr package provides generic wrapper functions,
which can be used instead of type-specific pointer wrapper functions.
This replaces the latter with the former, and migrates other uses of
the deprecated pointer package to ptr in affacted files.

See kubernetes/utils#283 for details.

Signed-off-by: Lan Liang <gcslyp@gmail.com>
liangyuanpeng added a commit to liangyuanpeng/kubernetes that referenced this pull request Apr 15, 2024
The new k8s.io/utils/ptr package provides generic wrapper functions,
which can be used instead of type-specific pointer wrapper functions.
This replaces the latter with the former, and migrates other uses of
the deprecated pointer package to ptr in affacted files.

See kubernetes/utils#283 for details.

Signed-off-by: Lan Liang <gcslyp@gmail.com>
liangyuanpeng added a commit to liangyuanpeng/kubernetes that referenced this pull request Apr 15, 2024
The new k8s.io/utils/ptr package provides generic wrapper functions,
which can be used instead of type-specific pointer wrapper functions.
This replaces the latter with the former, and migrates other uses of
the deprecated pointer package to ptr in affacted files.

See kubernetes/utils#283 for details.

Signed-off-by: Lan Liang <gcslyp@gmail.com>
liangyuanpeng added a commit to liangyuanpeng/kubernetes that referenced this pull request Apr 15, 2024
The new k8s.io/utils/ptr package provides generic wrapper functions,
which can be used instead of type-specific pointer wrapper functions.
This replaces the latter with the former, and migrates other uses of
the deprecated pointer package to ptr in affacted files.

See kubernetes/utils#283 for details.

Signed-off-by: Lan Liang <gcslyp@gmail.com>
liangyuanpeng added a commit to liangyuanpeng/kubernetes that referenced this pull request Apr 15, 2024
The new k8s.io/utils/ptr package provides generic wrapper functions,
which can be used instead of type-specific pointer wrapper functions.
This replaces the latter with the former, and migrates other uses of
the deprecated pointer package to ptr in affacted files.

See kubernetes/utils#283 for details.

Signed-off-by: Lan Liang <gcslyp@gmail.com>
liangyuanpeng added a commit to liangyuanpeng/kubernetes that referenced this pull request Apr 15, 2024
The new k8s.io/utils/ptr package provides generic wrapper functions,
which can be used instead of type-specific pointer wrapper functions.
This replaces the latter with the former, and migrates other uses of
the deprecated pointer package to ptr in affacted files.

See kubernetes/utils#283 for details.

Signed-off-by: Lan Liang <gcslyp@gmail.com>
liangyuanpeng added a commit to liangyuanpeng/kubernetes that referenced this pull request Apr 16, 2024
The new k8s.io/utils/ptr package provides generic wrapper functions,
which can be used instead of type-specific pointer wrapper functions.
This replaces the latter with the former, and migrates other uses of
the deprecated pointer package to ptr in affacted files.

See kubernetes/utils#283 for details.

Signed-off-by: Lan Liang <gcslyp@gmail.com>
liangyuanpeng added a commit to liangyuanpeng/kubernetes that referenced this pull request Apr 17, 2024
The new k8s.io/utils/ptr package provides generic wrapper functions,
which can be used instead of type-specific pointer wrapper functions.
This replaces the latter with the former, and migrates other uses of
the deprecated pointer package to ptr in affacted files.

See kubernetes/utils#283 for details.

Signed-off-by: Lan Liang <gcslyp@gmail.com>
jingczhang pushed a commit to nokia/kubernetes that referenced this pull request May 7, 2024
The new k8s.io/utils/ptr package provides generic wrapper functions,
which can be used instead of type-specific pointer wrapper functions.
This replaces the latter with the former, and migrates other uses of
the deprecated pointer package to ptr in affacted files.

See kubernetes/utils#283 for details.

Signed-off-by: Lan Liang <gcslyp@gmail.com>
liangyuanpeng added a commit to liangyuanpeng/karmada that referenced this pull request May 28, 2024
…nce a pointer.

The new k8s.io/utils/ptr package provides generic wrapper functions,
which can be used instead of type-specific pointer wrapper functions.
This replaces the latter with the former, and migrates other uses of
the deprecated pointer package to ptr in affacted files.

See kubernetes/utils#283 for details.

Signed-off-by: Lan Liang <gcslyp@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants