Skip to main content

Stere

PyPI PyPI - Python Version GitHub Updates Build status https://codecov.io/gh/jsfehler/stere/branch/master/graph/badge.svg?token=C1vfu8YgWn https://saucelabs.com/buildstatus/jsfehler

Stere is a library for writing Page Objects, designed to work on top of an existing automation library.

Design Philosophy

Many implementations of the Page Object model focus on removing the duplication of element locators inside tests. Stere goes one step further, offering a complete wrapper over the code that drives automation.

The goals of this project are to:

1 - Eliminate implementation code in test functions. Tests should read like a description of behaviour, not Selenium commands.

2 - Reduce the need for hand-written helper methods in Page Objects. Common actions should have universal solutions.

3 - Provide a simple pattern for writing maintainable Page Objects.

No automation abilities are built directly into the project; it completely relies on being hooked into other libraries. However, implementations using Splinter and Appium are available out of the box.

Documentation

https://stere.readthedocs.io/en/latest/

Basic Usage

Fundamentally, a Page Object is just a Python class.

A minimal Stere Page Object should:

1 - Subclass the Page class

2 - Declare Fields and Areas in the __init__ method

As an example, here’s the home page for Wikipedia:

from stere import Page
from stere.areas import Area, RepeatingArea
from stere.fields import Button, Input, Link, Root, Text


class WikipediaHome(Page):
    def __init__(self):
        self.search_form = Area(
            query=Input('id', 'searchInput'),
            submit=Button('xpath', '//*[@id="search-form"]/fieldset/button')
        )

        self.other_projects = RepeatingArea(
            root=Root('xpath', '//*[@class="other-project"]'),
            title=Link('xpath', '//*[@class="other-project-title"]'),
            tagline=Text('xpath', '//*[@class="other-project-tagline"]')
        )

The search form is represented as an Area with two Fields inside it.

A Field represents a single item, while an Area represents a unique collection of Fields.

The query and submit Fields didn’t have to be placed inside an Area. However, doing so allows you to use Area’s perform() method.

The links to other products are represented as a RepeatingArea . A RepeatingArea represents a non-unique collection of Fields on the page. Using the root argument as the non-unique selector, RepeatingArea will find all instances of said root, then build the appropriate number of Areas with all the other Fields inside.

It’s just as valid to declare each of the other products as a separate Area one at a time, like so:

self.commons = Area(
    root=Root('xpath', '//*[@class="other-project"][1]'),
    title=Link('xpath', '//*[@class="other-project-title"]'),
    tagline=Text('xpath', '//*[@class="other-project-tagline"]')
)

self.wikivoyage = Area(
    root=Root('xpath', '//*[@class="other-project"][2]'),
    title=Link('xpath', '//*[@class="other-project-title"]'),
    tagline=Text('xpath', '//*[@class="other-project-tagline"]')
)

Which style you pick depends entirely on how you want to model the page. RepeatingArea does the most good with collections where the number of areas and/or the contents of the areas can’t be predicted, such as inventory lists.

Using a Page Object in a test can be done like so:

def test_search_wikipedia():
    home = WikipediaHome()
    home.search_form.perform('kittens')

License

Distributed under the terms of the MIT license, “Stere” is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

Metadata

Release files for stere 0.31.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for stere 0.31.0
File Size Uploaded
stere-0.31.0.tar.gz 24.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for stere 0.31.0
File Interpreter ABI Platform
stere-0.31.0-py3-none-any.whl Python 3 none any Details

Total release size: 59.7 kB

Release files / stere-0.31.0.tar.gz

Download URL stere-0.31.0.tar.gz
Size 24.7 kB
Tags Source
SHA-256 checksum
How to use checksums
2ff37ea3d229f42713fd9e8e949bb66abbdf004ccc2bf8e62ee06f8c264c4773
BLAKE2b-256 checksum
How to use checksums
290d4b555e08d52db80b02bc03ce6e0c318a59b5517cfc1a3edbcfef96637ed0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.7

Release files / stere-0.31.0-py3-none-any.whl

Download URL stere-0.31.0-py3-none-any.whl
Size 35.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
97d3f337653af5f6e7b73d993ff6422bf5ed3b5ceeee5bd2882fc1c4a6907570
BLAKE2b-256 checksum
How to use checksums
2642e6ba3d16e110be1964ccfd7d3c880e05f95597d82efa7ad47e27f8033827
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.7

Release history Release notifications | RSS feed

This release

0.31.0 This release

2 release files

0.30.0

2 release files

0.29.0

2 release files

0.28.0

2 release files

0.27.0

2 release files

0.26.2

2 release files

0.26.1

2 release files

0.26.0

2 release files

0.25.0

2 release files

0.24.0

2 release files

0.23.0

2 release files

0.22.0

2 release files

0.20.0

2 release files

0.19.0

2 release files

0.18.0

2 release files

0.16.0

2 release files

0.15.0

2 release files

0.14.0

2 release files

0.13.0

2 release files

0.12.0

2 release files

0.11.0

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page