Expand and improve `pretty` for core data types, vector and table. #11438

jdunkerley · 2024-10-29T17:48:09Z

Pull Request Description

✅ Alter default Any.pretty so constructor is prefixed with type name (as needed now).
✅ Tests for pretty on Date.
pretty for ✅ Date_Time and ✅ Time_Of_Day improved to not have as much noise.
pretty for ✅ Period, ✅ Date_Range and ✅ Range.
Added custom pretty for ✅ Vector and ✅ Array as built-in method doesn't call through to overrides.
Added custom pretty for ✅ Column and ✅ Table.
Bug fix for pretty in Time_Zone so calls through to pretty of the zone_id to ensure safely escaped.
Initial default_widget for Date and Time_Of_Day.
Improve widget for Date.to_date_time.
to_text, to_display_text and pretty for Enso_Secret
private constructor for Enso_Secret as can't be correctly built directly.
Use _ for the testing methods in HTTP to clarify they shouldn't be used in general code.

Important Notes

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

The documentation has been updated, if necessary.
Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
All code follows the
Scala,
Java,
TypeScript,
and
Rust
style guides. In case you are using a language not listed above, follow the Rust style guide.
Unit tests have been written where possible.
If meaningful changes were made to logic or tests affecting Enso Cloud integration in the libraries,
or the Snowflake database integration, a run of the Extra Tests has been scheduled.
- If applicable, it is suggested to paste a link to a successful run of the Extra Tests.

Add widgets for `Date` and `Time_Of_Day`.

Add for Column and Table.

Remove unneeded brackets.

Date_Range.pretty fix.

Fix `Date_Range.pretty`. Tests for pretty on `Period` and `Date_Range`,

Tests for `Date_Time.pretty`.

Test for `Vector.pretty`.

distribution/lib/Standard/Base/0.0.0-dev/src/Enso_Cloud/Enso_Secret.enso

test/Base_Tests/src/Data/Vector_Spec.enso

…ecret.enso Co-authored-by: Radosław Waśko <[email protected]>

test/Base_Tests/src/Data/Range_Spec.enso

radeusgd · 2024-10-31T09:03:28Z

test/Base_Tests/src/Data/Time/Date_Time_Spec.enso

+        group_builder.specify "should convert to Enso code" <|
+            create_new_datetime 1970 . pretty . should_equal "Date_Time.new 1970 1 1"
+            create_new_datetime 1923 9 24 . pretty . should_equal "Date_Time.new 1923 9 24"
+            create_new_datetime 1923 9 24 12 20 44 . pretty . should_equal "Date_Time.new 1923 9 24 12 20 44"


I'd appreciate a test where hours and minutes are 0, so that we get the seconds=

radeusgd · 2024-10-31T09:56:56Z

test/Base_Tests/src/Network/Http_Spec.enso

-from Standard.Base.Network.HTTP import _resolve_headers, get_follow_redirects, get_proxy, get_timeout, get_version
+from Standard.Base.Network.HTTP import _resolve_headers, _get_follow_redirects, _get_proxy, _get_timeout, _get_version


Wasn't the convention for _ was to indicate module private methods?

Not opposed to using _ for 'internal method that is exported for test purposes', just making sure we have a clear guideline on the naming.

Also, I guess if we want to do this proper, we could mark these methods as private and move these few test cases into Base_Internal_Tests that can load private modules.

But ofc happy to proceed as-is for now.

I'm hoping we will get tests inside the same project soon and then these would be properly private.

radeusgd · 2024-10-31T09:57:35Z

test/Table_Tests/src/In_Memory/Column_Spec.enso

+            Debug.eval c1.pretty . should_equal c1
+
+            c2 = Column.from_vector "X" ["a", 42]
+            c2.pretty . should_equal 'Column.from_vector \'X\' [\'a\', 42]'


very minor nitpick, but wouldn't this test be more easily readable with "?

Suggested change

c2.pretty . should_equal 'Column.from_vector \'X\' [\'a\', 42]'

c2.pretty . should_equal "Column.from_vector 'X' ['a', 42]"

radeusgd

Looks great overall, just some minor suggestions

jdunkerley added 11 commits October 29, 2024 10:36

Improve pretty for Date_Time and Time_Of_Day.

0f51df6

Add widgets for `Date` and `Time_Of_Day`.

Improve recovery of widget when a parameter panics.

0b6c5ef

Fix Date_Time.

157fab8

Add pretty, text and js_object to Enso_Secret.

7dbd48c

Fix pretty on Enso_Secret and HTTP to use _ for the private methods.

186f749

Fix pretty for Date_Time.

ed6f61b

Add for Column and Table.

Add doc comments for pretty.

486aea1

Remove unneeded brackets.

Remove unneeded brackets.

4f18c02

Need type name in pretty for constructors.

6df9a71

Tests for Date and Time_Of_Day pretty.

2b36fc8

Vector.pretty and use it from Column and Table.

06c46e6

jdunkerley added the CI: No changelog needed Do not require a changelog entry for this PR. label Oct 29, 2024

jdunkerley added 9 commits October 29, 2024 17:51

Range.pretty.

28c5ddc

Work on tests.

da1a4a1

Date_Range.pretty fix.

Add pretty to Array.

2c37137

Minor fixes.

53d4281

Add pretty to Period.

28ea6b0

Fix `Date_Range.pretty`. Tests for pretty on `Period` and `Date_Range`,

Fix Date_Time.pretty.

99291ad

Tests for `Date_Time.pretty`.

Fix 'Column.pretty'.

ec1ba1f

Fix Range.pretty and test.

8b72138

Remove dupe import.

33c0657

Test for `Vector.pretty`.

jdunkerley marked this pull request as ready for review October 30, 2024 16:55

jdunkerley requested review from radeusgd, GregoryTravis, AdRiley, marthasharkey, 4e6, JaroslavTulach, hubertp and Akirathan as code owners October 30, 2024 16:55

4e6 approved these changes Oct 30, 2024

View reviewed changes

radeusgd reviewed Oct 30, 2024

View reviewed changes

distribution/lib/Standard/Base/0.0.0-dev/src/Enso_Cloud/Enso_Secret.enso Outdated Show resolved Hide resolved

GregoryTravis approved these changes Oct 30, 2024

View reviewed changes

test/Base_Tests/src/Data/Vector_Spec.enso Show resolved Hide resolved

jdunkerley and others added 3 commits October 30, 2024 17:30

Update distribution/lib/Standard/Base/0.0.0-dev/src/Enso_Cloud/Enso_S…

05d97e6

…ecret.enso Co-authored-by: Radosław Waśko <[email protected]>

Test for Array.pretty.

d24b95c

Test for Column.pretty and Table.pretty.

32ef62d

jdunkerley commented Oct 30, 2024

View reviewed changes

test/Base_Tests/src/Data/Range_Spec.enso Outdated Show resolved Hide resolved

Update test/Base_Tests/src/Data/Range_Spec.enso

30e4f90

jdunkerley commented Oct 30, 2024

View reviewed changes

test/Base_Tests/src/Data/Range_Spec.enso Outdated Show resolved Hide resolved

Update test/Base_Tests/src/Data/Range_Spec.enso

6f71860

jdunkerley commented Oct 30, 2024

View reviewed changes

test/Base_Tests/src/Data/Range_Spec.enso Outdated Show resolved Hide resolved

jdunkerley added 2 commits October 30, 2024 20:15

Update test/Base_Tests/src/Data/Range_Spec.enso

3fd6a95

Fix tests.

8fd61aa

radeusgd reviewed Oct 31, 2024

View reviewed changes

test/Base_Tests/src/Data/Range_Spec.enso Show resolved Hide resolved

radeusgd reviewed Oct 31, 2024

View reviewed changes

radeusgd approved these changes Oct 31, 2024

View reviewed changes

jdunkerley added the CI: Ready to merge This PR is eligible for automatic merge label Oct 31, 2024

mergify bot merged commit 610ee5f into develop Oct 31, 2024
42 checks passed

mergify bot deleted the wip/jd/column-table-pretty branch October 31, 2024 10:04

JaroslavTulach mentioned this pull request Nov 11, 2024

Design serde for Enso objects #11221

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expand and improve `pretty` for core data types, vector and table. #11438

Expand and improve `pretty` for core data types, vector and table. #11438

jdunkerley commented Oct 29, 2024 •

edited

Loading

radeusgd Oct 31, 2024

radeusgd Oct 31, 2024

jdunkerley Oct 31, 2024

radeusgd Oct 31, 2024

radeusgd left a comment

		from Standard.Base.Network.HTTP import _resolve_headers, get_follow_redirects, get_proxy, get_timeout, get_version
		from Standard.Base.Network.HTTP import _resolve_headers, _get_follow_redirects, _get_proxy, _get_timeout, _get_version

	c2.pretty . should_equal 'Column.from_vector \'X\' [\'a\', 42]'
	c2.pretty . should_equal "Column.from_vector 'X' ['a', 42]"

Expand and improve pretty for core data types, vector and table. #11438

Expand and improve pretty for core data types, vector and table. #11438

Conversation

jdunkerley commented Oct 29, 2024 • edited Loading

Pull Request Description

Important Notes

Checklist

radeusgd Oct 31, 2024

Choose a reason for hiding this comment

radeusgd Oct 31, 2024

Choose a reason for hiding this comment

jdunkerley Oct 31, 2024

Choose a reason for hiding this comment

radeusgd Oct 31, 2024

Choose a reason for hiding this comment

radeusgd left a comment

Choose a reason for hiding this comment

Expand and improve `pretty` for core data types, vector and table. #11438

Expand and improve `pretty` for core data types, vector and table. #11438

jdunkerley commented Oct 29, 2024 •

edited

Loading