Contents¶

Overview¶

docs
tests
package

Python parser for Microsoft Windows Event Reports (WER)

Free software: BSD license

Installation¶

pip install wer

Documentation¶

https://wer.readthedocs.io/

Development¶

To run the all tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows	set PYTEST_ADDOPTS=--cov-append tox
Other	PYTEST_ADDOPTS=--cov-append tox

Installation¶

At the command line:

pip install wer

Usage¶

To use wer in a project:

import wer

Reference¶

wer¶

class wer.Report(node=None, context=None, **kwargs)[source]¶

Windows Error Report

classmethod from_file(file_path)[source]¶: Creates a Report from a XML file

classmethod from_string(xml_string)[source]¶: Creates a Report from a XML string

wer.helpers¶

class wer.helpers.DateField(xpath)[source]¶

Custom date field

Uses the custom date mapper

class wer.helpers.DateMapper(format=None, normalize=False)[source]¶

Custom mapper for WER date

Converts XML timestamp to python datetime.datetime

wer.schema¶

class wer.schema.ApplicationInfo(node=None, context=None, **kwargs)[source]¶

ApplicationInfo complex type

company = <eulxml.xmlmap.fields.StringField>¶: Optional application company :type string

name = <eulxml.xmlmap.fields.StringField>¶: Application name :type string

path = <eulxml.xmlmap.fields.StringField>¶: Application executable path :type string

class wer.schema.EventInfo(node=None, context=None, **kwargs)[source]¶

EventInfo complex type

description = <eulxml.xmlmap.fields.StringField>¶: Event description :type string

name = <eulxml.xmlmap.fields.StringField>¶: Friendly event name :type string

report_type = <eulxml.xmlmap.fields.IntegerField>¶: Report type :type int

time = <wer.helpers.DateField>¶: Event date :type datetime.datetime

type = <eulxml.xmlmap.fields.StringField>¶: Event type :type string

class wer.schema.File(node=None, context=None, **kwargs)[source]¶

File complex type

name = <eulxml.xmlmap.fields.StringField>¶: File name :type string

type = <eulxml.xmlmap.fields.IntegerField>¶: File type :type int

class wer.schema.MachineInfo(node=None, context=None, **kwargs)[source]¶

MachineInfo complex type

lcid = <eulxml.xmlmap.fields.IntegerField>¶: Machine language identifier :type int

name = <eulxml.xmlmap.fields.StringField>¶: Machine name :type string

oem = <eulxml.xmlmap.fields.StringField>¶: Optional machine OEM name :type string

os = <eulxml.xmlmap.fields.StringField>¶: Machine operating system version :type string

class wer.schema.Parameter(node=None, context=None, **kwargs)[source]¶

Parameter complex type

id = <eulxml.xmlmap.fields.IntegerField>¶: Parameter ID :type int

name = <eulxml.xmlmap.fields.StringField>¶: Optional paramneter name :type string

value = <eulxml.xmlmap.fields.StringField>¶: Paramneter value :type string

class wer.schema.Report(node=None, context=None, **kwargs)[source]¶

Windows Error Report

application = <eulxml.xmlmap.fields.NodeField>¶: Application informations :type wer.schema.ApplicationInfo

event = <eulxml.xmlmap.fields.NodeField>¶: Event informations :type wer.schema.EventInfo

files = <eulxml.xmlmap.fields.NodeListField>¶: Event attached files :type list of wer.schema.File

classmethod from_file(file_path)[source]¶: Creates a Report from a XML file

classmethod from_string(xml_string)[source]¶: Creates a Report from a XML string

machine = <eulxml.xmlmap.fields.NodeField>¶: Machine informations :type wer.schema.MachineInfo

parameters = <eulxml.xmlmap.fields.NodeListField>¶: Event parameters :type list of wer.schema.Parameter

secondary_parameters = <eulxml.xmlmap.fields.NodeListField>¶: Event secondary parameters :type list of wer.schema.SecondaryParameter

user = <eulxml.xmlmap.fields.StringField>¶: User informations :type wer.schema.UserInfo

class wer.schema.SecondaryParameter(node=None, context=None, **kwargs)[source]¶

Secondary parameter complex type

id = <eulxml.xmlmap.fields.IntegerField>¶: Parameter ID :type int

value = <eulxml.xmlmap.fields.StringField>¶: Paramneter value :type string

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Bug reports¶

When reporting a bug please include:

Your operating system name and version.

Any details about your local setup that might be helpful in troubleshooting.

Detailed steps to reproduce the bug.

Documentation improvements¶

wer could always use more documentation, whether as part of the official wer docs, in docstrings, or even on the web in blog posts, articles, and such.

Feature requests and feedback¶

The best way to send feedback is to file an issue at https://github.com/gcrahay/python-wer/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development¶

To set up python-wer for local development:

Fork python-wer (look for the “Fork” button).

Clone your fork locally:

git clone git@github.com:your_name_here/python-wer.git

Create a branch for local development:
```
git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, run all the checks, doc builder and spell checker with tox one command:
```
tox
```

Commit your changes and push your branch to GitHub:

git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

If you need some code review or feedback while you’re developing the code just make the pull request.

For merging, you should:

Include passing tests (run tox) [1].
Update documentation when there’s new API, functionality etc.
Add a note to CHANGELOG.rst about the changes.
Add yourself to AUTHORS.rst.

[1]	If you don’t have all the necessary python versions available locally you can rely on Travis - it will run the tests for each change you add in the pull request. It will be slower though ...

Tips¶

To run a subset of tests:

tox -e envname -- py.test -k test_myfeature

To run all the test environments in parallel (you need to pip install detox):

detox

Authors¶

Gaetan Crahay - https://github.com/gcrahay

Changelog¶

0.1.0 (2016-06-05)¶

First release on PyPI.

Contents¶

Overview¶

Installation¶

Documentation¶

Development¶

Installation¶

Usage¶

Reference¶

wer¶

wer.helpers¶

wer.schema¶

Contributing¶

Bug reports¶

Documentation improvements¶

Feature requests and feedback¶

Development¶

Pull Request Guidelines¶

Tips¶

Authors¶

Changelog¶

0.1.0 (2016-06-05)¶

Indices and tables¶