ResearchNotes.form package

Here we define all form classes to keep the other files a bit more clean.

They are used by Flask - WTForm to render the input formulas.

We will follow the file structure of the database and keep related forms together. We will have an extra file for templates as they have a specific create and update menu (and dedicated forms for this).

Submodules

ResearchNotes.form.basics module

class ResearchNotes.form.basics.SearchForm(*args, **kwargs)[source]

Bases: FlaskForm

Form for the search bar in the main menu.

q = <UnboundField(SearchField, ('Search',), {'validators': [<wtforms.validators.DataRequired object>]})>

class ResearchNotes.form.basics.UserForm(*args, **kwargs)[source]

Bases: FlaskForm

Generic form for users profiles.

UserName: meta hide-value:

email = <UnboundField(StringField, ('Email Address', [<wtforms.validators.Length object>]), {})>

name: meta hide-value:

group_id: meta hide-value:

role_id: meta hide-value:

submit: meta hide-value:

validate_name(name)[source]

Validate for doubling of user.name (login handel).

Parameters:: name (str) – Login handel of user.
Raises:: validators – Raised if the login handel already exists.
Return type:: None.

validate_email(email)[source]

Validate for doubling of user.email.

Parameters:: email (str) – E-Mail to be used by user.
Raises:: validators – Raised, if e-mail is already in database and used by other user.
Return type:: None.

class ResearchNotes.form.basics.UserCreateForm(*args, **kwargs)[source]

Bases: UserForm

Create a user profile

password: meta hide-value:

class ResearchNotes.form.basics.UserUpdateForm(*args, **kwargs)[source]

Bases: UserForm

Update a user profile

class ResearchNotes.form.basics.ResetPassword(*args, **kwargs)[source]

Bases: FlaskForm

Reset user password.

password: meta hide-value:

confirm: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.basics.ConfigChangePasswdForm(*args, **kwargs)[source]

Bases: FlaskForm

Change your password in the configuration menu.

old: meta hide-value:

password: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.basics.LoginForm(*args, **kwargs)[source]

Bases: FlaskForm

Login fom at the entrance page.

username: meta hide-value:

password: meta hide-value:

remember: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.basics.LocationForm(*args, **kwargs)[source]

Bases: FlaskForm

Helper form to change location.

loc: meta hide-value:

subloc: meta hide-value:

location: meta hide-value:

ResearchNotes.form.documents module

class ResearchNotes.form.documents.DocCreateForm(*args, **kwargs)[source]

Bases: FlaskForm

Create or update a Documentation page.

label: meta hide-value:

title: meta hide-value:

body: meta hide-value:

submit: meta hide-value:

validate_label(label)[source]: Validate that label is unique and not use the name index.

ResearchNotes.form.ess_ppm_report module

class ResearchNotes.form.ess_ppm_report.SamplesCreateForm(*args, **kwargs)[source]

Bases: FlaskForm

Form for E/S/S creation and updating.

identifier: meta hide-value:

origin: meta hide-value:

creator: meta hide-value:

short_dis: meta hide-value:

long_dis: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.ess_ppm_report.SamplesShare(*args, **kwargs)[source]

Bases: FlaskForm

Helper form to share sample with other users.

group = <UnboundField(SelectField, ('Group',), {'coerce': <class 'int'>})>

user: meta hide-value:

usershare: meta hide-value:

class ResearchNotes.form.ess_ppm_report.SamplesLocation(*args, **kwargs)[source]

Bases: FlaskForm

Helper form to change sample location.

loc: meta hide-value:

location: meta hide-value:

class ResearchNotes.form.ess_ppm_report.ConfigCreateMType(*args, **kwargs)[source]

Bases: FlaskForm

Define a new measurement type.

mtype: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.ess_ppm_report.MeasurementCreateForm(*args, **kwargs)[source]

Bases: FlaskForm

Create and update a measurement.

short_dis: meta hide-value:

creator: meta hide-value:

mtype: meta hide-value:

instrument_id: meta hide-value:

long_dis: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.ess_ppm_report.ReportCreateForm(*args, **kwargs)[source]

Bases: FlaskForm

Create and update a report form.

title: meta hide-value:

long_dis: meta hide-value:

submit: meta hide-value:

ResearchNotes.form.form module

Here we define all form classes to keep the other files a bit more clean.

They are used by Flask - WTForm to render the input formulas.

ResearchNotes.form.instrument_journal module

class ResearchNotes.form.instrument_journal.ChooseDefaultTemplatesForm(*args, **kwargs)[source]

Bases: FlaskForm

Form to choose default templates for an instrument

ess_template: meta hide-value:

ppm_template: meta hide-value:

entry_template: meta hide-value:

save: meta hide-value:

class ResearchNotes.form.instrument_journal.InstrumentCreate(*args, **kwargs)[source]

Bases: FlaskForm

Create and update an Instrument record

identifier: meta hide-value:

parent_location = <UnboundField(SelectField, ('Location',), {'coerce': <class 'int'>})>

location_id: meta hide-value:

description: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.instrument_journal.InstrumentShare(*args, **kwargs)[source]

Bases: FlaskForm

Share instrument with guest users

user: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.instrument_journal.InstrumentationJournalEntryCreate(*args, **kwargs)[source]

Bases: FlaskForm

Create or update an Instrumentation Journal Entry

identifier: meta hide-value:

description: meta hide-value:

etype: meta hide-value:

submit: meta hide-value:

ResearchNotes.form.inventory module

All forms for inventory go here

class ResearchNotes.form.inventory.ItemCreateForm(*args, **kwargs)[source]

Bases: FlaskForm

Form for E/S/S creation and updating.

identifier: meta hide-value:

name: meta hide-value:

vendor: meta hide-value:

catalog: meta hide-value:

amount: meta hide-value:

unite: meta hide-value:

amount_is_int = <UnboundField(BooleanField, ('Amount is Integer',), {})>

location_id = <UnboundField(SelectField, ('Location',), {'coerce': <class 'int'>})>

sublocation_id = <UnboundField(SelectField, ('Sub-Location',), {'coerce': <class 'int'>})>

itype_id = <UnboundField(SelectField, ('Item Type',), {'coerce': <class 'int'>})>

description: meta hide-value:

submit: meta hide-value:

validate_identifier(identifier)[source]

validate_amount(amount)[source]

class ResearchNotes.form.inventory.ItemCheckout(*args, **kwargs)[source]

Bases: FlaskForm

amount = <UnboundField(FloatField, ('Amount to check out/return', [<wtforms.validators.InputRequired object>]), {})>

submit: meta hide-value:

validate_amount(amount)[source]

class ResearchNotes.form.inventory.ItemCheckoutInt(*args, **kwargs)[source]

Bases: FlaskForm

amount = <UnboundField(IntegerField, ('Amount to check out/return', [<wtforms.validators.InputRequired object>]), {})>

submit: meta hide-value:

validate_amount(amount)[source]

ResearchNotes.form.template module

class ResearchNotes.form.template.UseTemplate(*args, **kwargs)[source]

Bases: FlaskForm

Helper form to allow for the use of a Template.

template: meta hide-value:

use: meta hide-value:

class ResearchNotes.form.template.TemplateSamplesCreateForm(*args, **kwargs)[source]

Bases: FlaskForm

Create an E/S/S tem,plate or update one. Either from scratch of from existing E/S/S.

tname: meta hide-value:

identifier: meta hide-value:

origin: meta hide-value:

short_dis: meta hide-value:

long_dis: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.template.TemplateMeasurementCreateForm(*args, **kwargs)[source]

Bases: FlaskForm

Create a P/M/M tem,plate or update one. Either from scratch of from existing E/S/S.

tname: meta hide-value:

short_dis: meta hide-value:

mtype: meta hide-value:

instrument_id: meta hide-value:

creator: meta hide-value:

long_dis: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.template.TemplateInstrumentCreateForm(*args, **kwargs)[source]

Bases: FlaskForm

Create or update an Instrument template Can be used to create templates from an existing instrument or from scratch

tname: meta hide-value:

identifier: meta hide-value:

description: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.template.TemplateInstrumentationJournalEntryCreateForm(*args, **kwargs)[source]

Bases: FlaskForm

Create or update an Instrumentation Journal Entry template Can be used to create templates from an existing entry or from scratch

tname: meta hide-value:

identifier: meta hide-value:

etype: meta hide-value:

description: meta hide-value:

submit: meta hide-value:

class ResearchNotes.form.template.TemplateItemCreateForm(*args, **kwargs)[source]

Bases: FlaskForm

Form for item template creation and updating.

tname: meta hide-value:

identifier: meta hide-value:

name: meta hide-value:

vendor: meta hide-value:

catalog: meta hide-value:

amount: meta hide-value:

unite: meta hide-value:

amount_is_int = <UnboundField(BooleanField, ('Amount is Integer',), {})>

location_id = <UnboundField(SelectField, ('Location',), {'coerce': <class 'int'>, 'validate_choice': False})>

itype_id = <UnboundField(SelectField, ('Item Type',), {'coerce': <class 'int'>, 'validate_choice': False})>

description: meta hide-value:

submit: meta hide-value: