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

skitt · 2023-06-15T16:28:02Z

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 · 2023-06-15T16:28:10Z

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. 😃

alculquicondor

LGTM

pointer/pointer.go

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>

alculquicondor

/lgtm

skitt · 2023-06-16T12:14:36Z

/assign @mengqiy
/cc @thockin

skitt · 2023-06-16T15:40:20Z

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

thockin

Thanks!

/lgtm
/approve

k8s-ci-robot · 2023-07-14T23:08:03Z

[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:

~~OWNERS~~ [thockin]

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

alculquicondor · 2023-07-26T12:12:39Z

/hold cancel

The last 1.24 patch was released.

liyuerich · 2023-09-12T14:18:14Z

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

skitt · 2023-09-12T14:27:36Z

@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 · 2023-09-13T03:50:18Z

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

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>

…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>

…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> Signed-off-by: 08AHAD <91091911+08AHAD@users.noreply.github.com>

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>

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 requested review from dims and stewart-yu June 15, 2023 16:28

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

alculquicondor reviewed Jun 15, 2023

View reviewed changes

pointer/pointer.go Show resolved Hide resolved

skitt force-pushed the generic-ptr branch from 936a8f6 to dc1a5d8 Compare June 16, 2023 09:22

alculquicondor reviewed Jun 16, 2023

View reviewed changes

k8s-ci-robot assigned alculquicondor Jun 16, 2023

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

k8s-ci-robot assigned mengqiy Jun 16, 2023

k8s-ci-robot requested a review from thockin June 16, 2023 12:14

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

thockin reviewed Jul 14, 2023

View reviewed changes

k8s-ci-robot assigned thockin Jul 14, 2023

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

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 26, 2023

k8s-ci-robot merged commit 3b25d92 into kubernetes:master Jul 26, 2023

skitt deleted the generic-ptr branch August 17, 2023 15:02

skitt mentioned this pull request Aug 17, 2023

Use ptr.To to retrieve intstr addresses kubernetes/kubernetes#120008

Merged

Rei1010 mentioned this pull request Sep 13, 2023

Use ptr.Equal to compare the value kubernetes/kubernetes#120629

Merged

This was referenced Sep 13, 2023

Drop deprecated pointer package kubernetes/kubernetes#120631

Merged

drop deprecated pointer package in controller kubernetes/kubernetes#120699

Merged

danwinship mentioned this pull request Oct 11, 2023

Use k8s.io/utils/ptr in pkg/proxy kubernetes/kubernetes#121154

Merged

skitt mentioned this pull request Oct 13, 2023

REQUEST: New membership for skitt kubernetes/org#4520

Closed

9 tasks

alculquicondor mentioned this pull request Apr 12, 2024

Workqueue: Add generic versions that are properly typed kubernetes/kubernetes#124263

Merged

This was referenced Apr 15, 2024

pkg/util: drop pointer wrapper functions. kubernetes/kubernetes#124318

Open

pkg/volume: drop pointer wrapper functions. kubernetes/kubernetes#124319

Open

liangyuanpeng mentioned this pull request Apr 15, 2024

pkg/registry: drop pointer wrapper functions. kubernetes/kubernetes#124320

Merged

This was referenced Jun 11, 2024

pkg/printers: drop deprecated pointer package kubernetes/kubernetes#125439

Merged

pkg/volume: replace deprecated pointer package kubernetes/kubernetes#125451

Closed

Octopusjust mentioned this pull request Jul 3, 2024

pkg/kubelet: replace deprecated pointer package kubernetes/kubernetes#125854

Open

skitt mentioned this pull request Sep 23, 2024

pkg/api(s): drop pointer wrapper functions kubernetes/kubernetes#127578

Merged

aojea mentioned this pull request Oct 5, 2024

use utils/ptr package instead of utils/pointer kubernetes/kubernetes#125936

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

skitt commented Jun 15, 2023 •

edited

Loading

k8s-ci-robot commented Jun 15, 2023

alculquicondor left a comment

alculquicondor left a comment

skitt commented Jun 16, 2023

skitt commented Jun 16, 2023

thockin left a comment

k8s-ci-robot commented Jul 14, 2023

alculquicondor commented Jul 26, 2023

liyuerich commented Sep 12, 2023

skitt commented Sep 12, 2023

Rei1010 commented Sep 13, 2023 •

edited

Loading

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

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

Conversation

skitt commented Jun 15, 2023 • edited Loading

k8s-ci-robot commented Jun 15, 2023

alculquicondor left a comment

Choose a reason for hiding this comment

alculquicondor left a comment

Choose a reason for hiding this comment

skitt commented Jun 16, 2023

skitt commented Jun 16, 2023

thockin left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jul 14, 2023

alculquicondor commented Jul 26, 2023

liyuerich commented Sep 12, 2023

skitt commented Sep 12, 2023

Rei1010 commented Sep 13, 2023 • edited Loading

skitt commented Jun 15, 2023 •

edited

Loading

Rei1010 commented Sep 13, 2023 •

edited

Loading