stdlib 0.40: change the implementation of `dict.update` #659

inoas · 2024-07-10T15:12:23Z

Replaces #610

inoas · 2024-07-10T15:15:40Z

src/gleam/dict.gleam


-/// A dictionary of keys and values.
+/// A dictionary (dict) of keys and values.


Should maybe "dict" in comments be replaced by Dict?

Revert this please 🙏

inoas · 2024-07-10T15:31:43Z

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog

+## v0.40.0 - Unreleased
+
+- The previously deprecated `update` function of the `dict` has been replaced


I am not fond of this changelog entry.

I think we can just say "The dict module gains the update function.".

inoas · 2024-07-10T15:31:55Z

src/gleam/dict.gleam

@@ -474,13 +474,63 @@ pub fn upsert(
  |> insert(dict, key, _)
 }

-@deprecated("This function has been renamed to `upsert`")
+/// Returns a dict where the caller attempts to change a key-value pair in the


I am not happy with this explanation.

Any better ideas?

Perhaps something more concise?

Updates the value in a dict for a given key using a given function.

If there already was a value in the dict for the key then it is passed into the function.

If a value is returned from the function then it will be used as the new value in the dict. If no value is returned then any previous value is removed.

If a value is returned from the function then it will be used as the new
value in the dict. If no value is returned then any previous value is removed.

But is this true?

The change callback can on None case add the key by returning Ok(value) (or Some(value))? Or did I miss something.

I am updating the tests so it is clearer that the change function is very powerful and flexible.

This shows an example where I cannot see that the function description above matches. Because it really depends on the change callback/function what happens here.

https://github.com/gleam-lang/stdlib/pull/659/files#diff-99caf068f3c916909bcf3231d839db8a8afdebb65dc04d0353eea53071729264R265-R278

src/gleam/dict.gleam

inoas · 2024-07-10T15:34:45Z

I think this function should be called change.

I think the other implementation already done should be called update https://github.com/gleam-lang/stdlib/pull/610/files.

Update means that there already is something and it can fail to update. Update does not signal removal. Change signals removal. Change fits to this PR, update to the other.

lpil

Thank you

lpil · 2024-07-25T13:04:57Z

src/gleam/dict.gleam

+pub fn update(
+  in dict: Dict(k, v),
+  update key: k,
+  with fun: fn(Option(v)) -> Result(v, Nil),


Could you use Option for the return value here please

I thought we are not using Option for Return values.
If we have regular functions following that pattern, we then cannot apply those in this update function?

lpil · 2024-07-25T13:05:28Z

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog

+## v0.40.0 - Unreleased
+
+- The previously deprecated `update` function of the `dict` has been replaced


I think we can just say "The dict module gains the update function.".

lpil · 2024-07-25T13:05:50Z

src/gleam/dict.gleam


-/// A dictionary of keys and values.
+/// A dictionary (dict) of keys and values.


Revert this please 🙏

lpil · 2024-07-25T13:08:04Z

src/gleam/dict.gleam

@@ -474,13 +474,63 @@ pub fn upsert(
  |> insert(dict, key, _)
 }

-@deprecated("This function has been renamed to `upsert`")
+/// Returns a dict where the caller attempts to change a key-value pair in the


Perhaps something more concise?

Updates the value in a dict for a given key using a given function.

If there already was a value in the dict for the key then it is passed into the function.

If a value is returned from the function then it will be used as the new value in the dict. If no value is returned then any previous value is removed.

lpil · 2024-07-25T13:08:37Z

src/gleam/dict.gleam

+///
+/// dict
+/// |> dict.update("e", inc_if_exists_or_discard)
+/// // -> from_list([#("a", 0), #("b", 1), #("c", 2)])


I don't think this shows the functionality very clearly. One example per code block would be good

I am not certain I follow. Per which code block?

inoas · 2024-07-26T13:02:06Z

@lpil are you certain about this being named update rather than change?

lpil · 2024-07-26T17:25:24Z

What's the motivation for it being change. I thought we did the whole deprecation cycle to free up the name update?

inoas · 2024-07-29T21:13:11Z

What's the motivation for it being change. I thought we did the whole deprecation cycle to free up the name update?

update could be used for this impl if so desired https://github.com/gleam-lang/stdlib/pull/610/files#diff-8630634f9cc0ec3abcfa5aea55f3be0e549a2131a5cce9b7f551f880ceaaaac4R497-R502
More importantly, the word update signifies that a key-pair value should exist and is updated, but the impl in this PR here may insert even if there is no key or remove if there is a key (see the test suite in this PR for examples), all depending on the change function/callback.

It changes the dict based on the function, so IMHO change is much clearer, whereas if I read dict.update I would not assume that afterwads a key-value pair is potentially removed from the dict (or added if not existing prior).

inoas · 2024-07-29T21:42:50Z

test/gleam/dict_test.gleam

+  // Utilize a function returning a `Result` in the change function.
+  let half_or_zero_else_noop = fn(x) {
+    case x {
+      Some(i) -> int.divide(i, 2)


Because other functions usually return Result rather than Option, I have opted for the change function to return Result not Option as well.

I have added a unit test example to show what I mean.

Are you certain you want to return Option instead?

ref #659 (comment) cc @lpil

inoas · 2024-07-29T22:33:16Z

After feedback I made the changes to return Option rather than Result and tried to simplify the docs and the unit tests

inoas · 2024-09-26T15:45:31Z

This is still ready to be reviewed/merged unless you want me to rename this to change and have update do the other impl (see above). Please let me know if there are still things to do.

inoas added 2 commits July 10, 2024 16:44

dict

3c1ee74

new dict.update

b6fbaa4

inoas mentioned this pull request Jul 10, 2024

Add dict.change? #599

Closed

inoas changed the title ~~Replace deprecated update~~ stdlib 0.40: change the implementation of dict.update Jul 10, 2024

gleam-1.3.0-format

8dcbbcd

inoas mentioned this pull request Jul 10, 2024

stdlib 0.40: reuse dict.update #610

Closed

inoas commented Jul 10, 2024

View reviewed changes

inoas added 3 commits July 10, 2024 17:18

examples

299c611

comments, tests

666cb98

improve docs

60af382

inoas commented Jul 10, 2024

View reviewed changes

inoas marked this pull request as draft July 10, 2024 15:39

Merge branch 'main' into replace-deprecated-update

27b9ee7

inoas marked this pull request as ready for review July 18, 2024 18:47

inoas added 2 commits July 18, 2024 20:48

Update ci.yml

fa429d8

Update CHANGELOG.md

7189cf1

lpil reviewed Jul 25, 2024

View reviewed changes

inoas added 4 commits July 29, 2024 23:13

Merge branch 'main' into replace-deprecated-update

cf2c6d1

changelog-docs-tests

13810f6

test-fn-names

da25af5

dict-test

c335fc9

inoas commented Jul 29, 2024

View reviewed changes

inoas added 2 commits July 30, 2024 00:29

fixup callback types, tests

9b667a5

update test callback names

89e76af

inoas requested a review from lpil September 26, 2024 15:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

stdlib 0.40: change the implementation of `dict.update` #659

stdlib 0.40: change the implementation of `dict.update` #659

inoas commented Jul 10, 2024 •

edited

Loading

inoas Jul 10, 2024 •

edited

Loading

lpil Jul 25, 2024

inoas Jul 10, 2024

lpil Jul 25, 2024

inoas Jul 10, 2024

inoas Jul 18, 2024

lpil Jul 25, 2024

inoas Jul 29, 2024

inoas Jul 29, 2024

inoas commented Jul 10, 2024

lpil left a comment

lpil Jul 25, 2024

inoas Jul 26, 2024

lpil Jul 25, 2024

lpil Jul 25, 2024

lpil Jul 25, 2024

lpil Jul 25, 2024

inoas Jul 26, 2024

inoas commented Jul 26, 2024

lpil commented Jul 26, 2024

inoas commented Jul 29, 2024 •

edited

Loading

inoas Jul 29, 2024

inoas commented Jul 29, 2024

inoas commented Sep 26, 2024


		/// A dictionary of keys and values.
		/// A dictionary (dict) of keys and values.

stdlib 0.40: change the implementation of dict.update #659

Are you sure you want to change the base?

stdlib 0.40: change the implementation of dict.update #659

Conversation

inoas commented Jul 10, 2024 • edited Loading

inoas Jul 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

inoas commented Jul 10, 2024

lpil left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

inoas commented Jul 26, 2024

lpil commented Jul 26, 2024

inoas commented Jul 29, 2024 • edited Loading

Choose a reason for hiding this comment

inoas commented Jul 29, 2024

inoas commented Sep 26, 2024

stdlib 0.40: change the implementation of `dict.update` #659

stdlib 0.40: change the implementation of `dict.update` #659

inoas commented Jul 10, 2024 •

edited

Loading

inoas Jul 10, 2024 •

edited

Loading

inoas commented Jul 29, 2024 •

edited

Loading