IsVisible

[mackthehack]

First I want to say thank you to the ScreenPy community for the great Python product.

I'm working to upgrade our instance of ScreenPy to > v4 and I'm having trouble with an IsVisible method that was in the resolutions class, but seems to have been deprecated. Is there any information on what I should use to replace that call with?

[perrygoy]

Hi @mackthehack! Thanks for reaching out, we're still in the phase where it's cool to hear about others using this project. :D

Yes, part of the upgrade to version 4 was to break ScreenPy apart at the Abilities level. IsVisible needs the BrowseTheWeb Ability, which enables using Selenium, so it was moved over to screenpy-selenium. To get access, you'll need to make these changes:

1. Change your install from screenpy to screenpy[selenium] to install screenpy and screenpy-selenium.
2. Change these bits from this:

from screenpy.abilities import BrowseTheWeb
from screenpy.resolutions import IsVisible

to

from screenpy_selenium.abilities import BrowseTheWeb
from screenpy_selenium.resolutions import IsVisible

We also have this page in the documentation that goes through everything more thoroughly: https://screenpy-docs.readthedocs.io/en/latest/deprecations.html#breaking-changes

Let us know if that works! Also let us know if it doesn't!

[mackthehack]

Perry - Thanks for your continued support!

I appreciate you letting me know the proper import path, one suggestion I might make for the future is making the deprecation page where you show the moved import paths also denote the selenium resolutions library's import path. It was slightly confusing to me that there are two resolutions classes in the project and I wasn't able to understand that because IsVisible is now in the separate namespace. I searched for IsVisible, and found the only reference to it on the deprecations page, which makes sense, but just throwing it into that reference update blurb would be incredibly helpful.

Thanks Again!

[perrygoy]

Thanks, that's good feedback!

Actually, we're working on an update to ScreenPy and all of the "official" extensions that would make it so you can import all the base features from the extension as well. So if you're only using ScreenPy Selenium, you'd be able to do this:

from screenpy_selenium import (
    AnActor,
    Click,
    Eventually,
    given,
    IsVisible,
    ReadsExactly,
    then,
    when,
)

We're hoping that will make it a lot easier on people using our libraries if we decide to move things around again. I'd actually like your feeback on that if you don't mind—do you think that will be useful, or confusing? Do you like knowing which pieces come from the base screenpy library and which ones come from screenpy_selenium, or would you prefer to keep the imports very clean like this?

(Note that this new feature would not need to be used, you could leave your imports as they are and both ScreenPy and its extensions will continue to work.)