Add screenshot 1342 #2039

sabadam32 · 2024-03-29T04:02:01Z

Fixes #1342

changed doc subsection header renamed old subsection

This reverts commit e2c8b46.

…into development

pushfoo

I can't speaks to the GL side, but there are some immediate changes I see as room for improvement. Included file in here + some possible improvements.

tash apply

arcade/application.py

arcade/window_commands.py

tash apply

arcade/application.py

tests/unit/window/test_screenshot.py

einarf · 2024-03-29T18:35:11Z

What about the old arcade.get_image() and arcade.get_pixel()? We also talked about having screenshot feature in cameras. I think get_image() also have some history related to pixel ratio > 1.0. I don't quite remeber if we ended up scaling the screenshot itself.

pushfoo · 2024-03-31T01:53:35Z

also have some history related to pixel ratio > 1.0

Is this HiDPI or strange edge cases where non-square pixels exist? To my knowledge, that only exists on ancient platforms, but I figured I should double check.

* Add screenshot overview + example * Add HasStrftime Protocol type * Add arcade.get_timestamp * Add some cross-referencing between logging and other doc * Add doc on datetime replacements which are nicer for filename templating

* Fix typo in first line * Remove compaction of arcade.get_timestamp link

* Remove extra sentence * Add list item linking the better datetime overview

* Re-order arguments for get_timestamp * Improve default timestamp format string * Add time-machine test helper to pyproject.toml * Add tests for get_timestamp * Update doc to cover changes

* Add %Z to get_timestamp * Add doc on it + cross-refs * Clean datetime test imports

Begin strengthening screenshot PR

…into development

pushfoo

TL;DR: _TzInfo is protected and ugly, but so was my previous PR due to pyright breakage. Sorry about that.

I'd run a local pyright check on the changes I proposed. My pyright is broken because of nodejs issues on my distro, sadly. Sorry about my previous PR being a little broken because of it.

pushfoo · 2024-04-06T01:03:37Z

arcade/__init__.py

@@ -34,6 +35,50 @@ def configure_logging(level: Optional[int] = None):
        LOG.addHandler(ch)


+def get_timestamp(
+        how: str = "%Y_%m_%d_%H%M_%S_%f%Z",
+        when: Optional[types.HasStrftime | datetime] = None,


Did HasStrftime not match datetime? Was it only pyright which complained?

To my understanding, the | syntax is a 3.9+ feature, but we support 3.8+

No it didn't. pyright complained for sure, but I don't remember if the build failed due to this check

Are you sure? I see references to line 41 in the GitHub CI builds on the previous commits. That's the other line it seems.

pushfoo · 2024-04-06T01:46:22Z

arcade/__init__.py

@@ -9,7 +9,7 @@
 # Error out if we import Arcade with an incompatible version of Python.
 import sys
 import os
-from datetime import datetime
+from datetime import datetime, _TzInfo


My initial PR might have been a little busted due to my local nodejs breaking my pyright (I know pyright shouldn't depend on node, but it does 😢). This should work (I think):

Suggested change

from datetime import datetime, _TzInfo

from datetime import datetime, tzinfo

The Python source for the datetime module shows it as a real ABC, and it should be less brittle than _TZInfo.

pushfoo · 2024-04-06T01:48:13Z

arcade/__init__.py

-        when: Optional[types.HasStrftime] = None,
-        tzinfo: Optional[datetime.tzinfo] = None
+        when: Optional[types.HasStrftime | datetime] = None,
+        tzinfo: Optional[_TzInfo] = None


I think I removed a top-level datetime import but left behind the broken property datetime.tzinfo line earlier. With the import suggestion at the top, I think this should work.

Suggested change

tzinfo: Optional[_TzInfo] = None

tzinfo: Optional[tzinfo] = None

…into development

pvcraven · 2024-04-11T14:05:17Z

I like having the additional docs.

Although, in the past, when people have wanted to do a screenshot we've just pointed them to:

image = get_image()
image.save('screenshot.png', 'PNG')

This seems like a lot to add to the library for screenshots when two-lines can also run a screenshot.

If we do add it, can we get some unit tests?

pushfoo · 2024-04-11T17:01:57Z

TL;DR:

We have some unit tests already
- tests/unit/window/test_screenshot.py
- tests/unit/window/test_get_timestamp
It seems since it's all at once instead of over 3+ years
save_image is clear and discoverable

The Precedent is 2-3 Feature Exposures

This seems like a lot to add to the library for screenshots

In the past, we slowly added features to the top-level namespace, Window, and View. Two of the top examples:

Feature	`Window`	`View`	`Top-level`
Clearing	`Window.clear()`	`View.clear()`	`arcade.start_render()` (`arcade.get_window.clear()`)
Setting BG color	`Window.background_color`	`View.background_color`	`arcade.set_background_color`

Why Do It For Screenshots?

View is expected to share core API features with Window
arcade.get_image sets the precedent for exposing screenshots at the top level

Unit Tests

If we do add it, can we get some unit tests?

Can you elaborate? We already have some here:

If you'd like, we add some to explicitly cover View.

…into development

sabadam32 and others added 9 commits March 1, 2024 23:09

fixed the header levels in the sprite doc

e2c8b46

changed doc subsection header renamed old subsection

Revert "fixed the header levels in the sprite doc"

c2dcc0f

This reverts commit e2c8b46.

Merge branch 'pythonarcade:development' into development

b0d6718

Merge branch 'development' of https://github.com/pythonarcade/arcade …

5377d26

…into development

Merge branch 'development' of https://github.com/pythonarcade/arcade …

b8ff2f4

…into development

Merge branch 'development' of https://github.com/pythonarcade/arcade …

6d5b217

…into development

Merge branch 'development' of https://github.com/pythonarcade/arcade …

37a5224

…into development

added screenshot functions

7523e89

fix tests

cc598c8

pushfoo suggested changes Mar 29, 2024

View reviewed changes

sabadam32 and others added 4 commits March 28, 2024 23:41

fix locations

3d47991

removed stash file and updated screenshot oath

e061b0c

fix tests

ce14121

Use cleaner pytest screenshot fixtures

3472eab

pushfoo added 14 commits March 30, 2024 22:22

Try to make Window.save_screenshot friendlier + better documented

d38d28e

Use shorter intersphinx mapping instead of full URL

b104c00

Phrasing tweak for Window.save_screenshot docstring

931075e

Sync implementation + docstring for window_command.save_screenshot

6811519

Use intersphinx link in screenshot kwargs field

b377f88

Add Window.save_timestamped_screenshot method + doc

0dcdcf1

Add creenshot / helper doc, helpers, and examples

161566e

* Add screenshot overview + example * Add HasStrftime Protocol type * Add arcade.get_timestamp * Add some cross-referencing between logging and other doc * Add doc on datetime replacements which are nicer for filename templating

Revert get_timestamped_screenshot

29ccec7

Spacing in Window.__init__

2b74056

Revert whitespace noise in application.py

f70685a

Commit overlooked example py file + screenshot for doc

6741ea9

Fix code-block directive spacing

eb900a6

Better date and time section tweaks

b6b5341

* Fix typo in first line * Remove compaction of arcade.get_timestamp link

Intro block revision

b53b413

pushfoo and others added 13 commits March 31, 2024 11:18

Second pair of intro tweaks

c42872a

* Remove extra sentence * Add list item linking the better datetime overview

Add module-level spacing above get_timestamp

ae00a90

Put format string first in get_timestamp

2dfd5b5

Add tzinfo to get_timestamp

09a363e

Account for DX + Sabadam32's suggestions

50d38ee

* Re-order arguments for get_timestamp * Improve default timestamp format string * Add time-machine test helper to pyproject.toml * Add tests for get_timestamp * Update doc to cover changes

Add timezone to format string + clean up tests

e6a708a

* Add %Z to get_timestamp * Add doc on it + cross-refs * Clean datetime test imports

Phrasing tweak to intro

d7eeecb

Merge pull request #1 from pushfoo/screenshot_pr_cleaning

8e92ac5

Begin strengthening screenshot PR

add in get_image

f585d83

Merge branch 'development' of https://github.com/pythonarcade/arcade …

37b0962

…into development

Merge branch 'development' into add_screenshot_1342

caa493e

fix typing errors

5aafe39

fix type error

90164e8

pushfoo suggested changes Apr 6, 2024

View reviewed changes

sabadam32 added 2 commits April 5, 2024 21:43

removed datetime type

58f2d70

Merge branch 'development' of https://github.com/pythonarcade/arcade …

ff1abb1

…into development

pushfoo mentioned this pull request Apr 18, 2024

Initial cleanup of arcade.types #2065

Merged

sabadam32 added 4 commits April 20, 2024 11:48

Merge branch 'development' of https://github.com/pythonarcade/arcade …

a2278d3

…into development

Merge branch 'development' into add_screenshot_1342

d9c0178

Merge branch 'development' of https://github.com/pythonarcade/arcade …

856689a

…into development

Merge branch 'development' into add_screenshot_1342

43e6ac5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add screenshot 1342 #2039

Add screenshot 1342 #2039

sabadam32 commented Mar 29, 2024 •

edited

pushfoo left a comment

einarf commented Mar 29, 2024

pushfoo commented Mar 31, 2024

pushfoo left a comment

pushfoo Apr 6, 2024

sabadam32 Apr 6, 2024 •

edited

pushfoo Apr 6, 2024 •

edited

pushfoo Apr 6, 2024

pushfoo Apr 6, 2024

pvcraven commented Apr 11, 2024

pushfoo commented Apr 11, 2024 •

edited

	from datetime import datetime, _TzInfo
	from datetime import datetime, tzinfo

	tzinfo: Optional[_TzInfo] = None
	tzinfo: Optional[tzinfo] = None

Add screenshot 1342 #2039

Are you sure you want to change the base?

Add screenshot 1342 #2039

Conversation

sabadam32 commented Mar 29, 2024 • edited

pushfoo left a comment

Choose a reason for hiding this comment

einarf commented Mar 29, 2024

pushfoo commented Mar 31, 2024

pushfoo left a comment

Choose a reason for hiding this comment

pushfoo Apr 6, 2024

Choose a reason for hiding this comment

sabadam32 Apr 6, 2024 • edited

Choose a reason for hiding this comment

pushfoo Apr 6, 2024 • edited

Choose a reason for hiding this comment

pushfoo Apr 6, 2024

Choose a reason for hiding this comment

pushfoo Apr 6, 2024

Choose a reason for hiding this comment

pvcraven commented Apr 11, 2024

pushfoo commented Apr 11, 2024 • edited

The Precedent is 2-3 Feature Exposures

Why Do It For Screenshots?

Unit Tests

sabadam32 commented Mar 29, 2024 •

edited

sabadam32 Apr 6, 2024 •

edited

pushfoo Apr 6, 2024 •

edited

pushfoo commented Apr 11, 2024 •

edited