Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Make links in README absolute #20

Merged
merged 1 commit into from
Aug 16, 2024
Merged

docs: Make links in README absolute #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,22 @@ The GUI implementation would be a class that derives from
[QWidget](https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QWidget.html), e.g.
[QMainWindow](https://doc.qt.io/qtforpython-5/PySide2/QtWidgets/QMainWindow.html).
A very basic example class called `FigureWindow` can be found in
[window.py](pqthreads/examples/window.py#L11).
[window.py](https://github.com/swvanbuuren/pqthreads/blob/master/pqthreads/examples/window.py#L11).

### Worker class

In a class that inherits from
[containers.WorkerItem](pqthreads/containers.py#L90) you then choose which
methods and attributes are exposed. An examples of this is the class
`FigureWorker` as found in [worker.py](pqthreads/examples/worker.py#L14).
[containers.WorkerItem](https://github.com/swvanbuuren/pqthreads/blob/master/pqthreads/containers.py#L90)
you then choose which methods and attributes are exposed. An examples of this is
the class `FigureWorker` as found in
[worker.py](https://github.com/swvanbuuren/pqthreads/blob/master/pqthreads/examples/worker.py#L14).

### Putting it all together

Using the GUI implementation `FigureWindow` and worker class `FigureWorker` the
utilities from [decorator.py](pqthreads/decorator.py) can be used to create a
custom decorator:
utilities from
[decorator.py](https://github.com/swvanbuuren/pqthreads/blob/master/pqthreads/decorator.py)
can be used to create a custom decorator:

```python
from pqthreads import decorator
Expand Down Expand Up @@ -85,13 +87,14 @@ def main():

As illustrated in the previous section, worker class interfaces are accessed
through the so-called `worker` references (as is provided in the module
[`refs`](pqthreads/refs.py)). All interfaces are provided as weak references. As
soon as the decorated function is exited, the weak references will invalidate
and can't be used anymore. Therefore, it's recommended to decorate the function
that encapsulates the whole python program in question. This assures that
different parts of your own program run in different threads.

The module [`refs`](pqthreads/refs.py) also comes with an object called `gui`
[`refs`](https://github.com/swvanbuuren/pqthreads/blob/master/pqthreads/refs.py)).
All interfaces are provided as weak references. As soon as the decorated
function is exited, the weak references will invalidate and can't be used
anymore. Therefore, it's recommended to decorate the function that encapsulates
the whole python program in question. This assures that different parts of your
own program run in different threads.

The module [`refs`](https://github.com/swvanbuuren/pqthreads/blob/master/pqthreads/refs.py) also comes with an object called `gui`
references that stores weak references to the GUI objects. These also will
invalidate when the decorated function is exited.

Expand Down
Loading