Expand type annotations and add classes for path item handling#412
Open
pappnu wants to merge 32 commits into
Open
Expand type annotations and add classes for path item handling#412pappnu wants to merge 32 commits into
pappnu wants to merge 32 commits into
Conversation
…add various missing properties BREAKING CHANGE: Uses syntax that requires Python 3.10, removes echo, compareWithNumbers and system functions, which simply wrapped basic Python constructs without adding any extra functionality, and makes getByName return None instead of throwing when no match is found.
…ugh they are converted to integers
…date dependencies
…m any child object
Author
|
@loonghao The hound bot seems to complain about valid overload definitions and its documentation suggests that it is using a very old version of Flake8. Should it be removed from the project? I assume that there would be more up to date alternatives, though I'm not familiar with such tools. The pull request workflows also check at least partially the same things that the hound bot does. |
Ruff does basically everything that the aforementioned tools do, but more efficiently and with less configuration.
![hound[bot]](https://avatars.githubusercontent.com/in/3598?s=60&v=4){kind=small}
| resolution (int): The resolution of the document (in pixels per inch) | ||
| width (float): The width of the document. Non-integer values are converted to integers. | ||
| height (float): The height of the document. Non-integer values are converted to integers. | ||
| resolution (float): The resolution of the document (in pixels per inch) |
| height (int): The height of the document. | ||
| resolution (int): The resolution of the document (in pixels per inch) | ||
| width (float): The width of the document. Non-integer values are converted to integers. | ||
| height (float): The height of the document. Non-integer values are converted to integers. |
| width (int): The width of the document. | ||
| height (int): The height of the document. | ||
| resolution (int): The resolution of the document (in pixels per inch) | ||
| width (float): The width of the document. Non-integer values are converted to integers. |
| """ | ||
| dup = self.app.duplicate(relativeObject, insertionLocation) | ||
| return ArtLayer(dup) | ||
| return ArtLayer(self.app.duplicate(relativeObject.app if relativeObject else None, insertionLocation)) |
| self.app.applyOceanRipple(size, magnitude) | ||
|
|
||
| def applyOffset(self, horizontal, vertical, undefinedAreas): | ||
| def applyOffset(self, horizontal: int, vertical: int, undefinedAreas: OffsetUndefinedAreas) -> None: |
| resolution: The resolution (in pixels per inch) | ||
| automatic: Value for automatic. | ||
| resampleMethod: The downsample method. | ||
| amount: Amount of noise value when using preserve details (range: 0 - 100) |
| self.app.splitChannels() | ||
|
|
||
| def suspendHistory(self, historyString, javaScriptString): | ||
| def suspendHistory(self, historyString: str, javaScriptString: str) -> None: |
| asCopy: Saves the document as a copy, leaving the original open. | ||
| """ | ||
| return self.app.saveAs(file_path, options, asCopy, extensionType) | ||
| self.app.saveAs(file_path, options.app if options else None, asCopy, extensionType) |
| self.app.rasterizeAllLayers() | ||
|
|
||
| def recordMeasurements(self, source, dataPoints): | ||
| def recordMeasurements(self, source: MeasurementSource, dataPoints: str) -> None: |
| self.app.export(file_path, exportAs, options.app) | ||
|
|
||
| def duplicate(self, name=None, merge_layers_only=False): | ||
| def duplicate(self, name: str | None = None, merge_layers_only: bool = False) -> "Document": |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds extensive type annotations, various missing properties, classes for interacting with path items and tries to lessen some of the repetition within the code. The type annotations don't cover everything, especially things that would have required creating new wrapper classes. The annotations are mostly based on Photoshop Scripting Reference and Photoshop VBS Scripting Reference 2020.
Breaking Changes
Application.compareWithNumbers,Application.systemandSession.echofunctions as they simply wrapped basic Python actions without adding any extra functionality to them, so I assumed they aren't really necessary.getByNamenow returnsNoneinstead of throwing, as I find that easier to work with in a strictly typed codebase.Testing
I added some tests of my own and ran some of the existing tests, though many of them didn't pass even when using the version from main branch. I have also used this extensively with Proxyshop, which uses especially the basic layer modification and action manager parts of the API. There's still many untested properties and functions, so bugs are quite likely.
This might also help with #405.
Please let me know what further changes would be required to get this merged.