bika.lims.content.worksheettemplate.WorksheetTemplate._getMethodsVoc() - Code Metrics - Inspection of "Fix instruments not filtered by method in Workshee..." - senaite/senaite.core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 2.x ( 7dbd5c...d2326f )

by Jordi

created 2022-05-04 08:22 UTC

WorksheetTemplate._getMethodsVoc() A

↳ Parent: bika.lims.content.worksheettemplate

Complexity

Conditions

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	9
dl	0
loc	13
rs	9.95
c	0
b	0
f	0
cc	3
nop	1

# -*- coding: utf-8 -*-
#
# This file is part of SENAITE.CORE.
#
# SENAITE.CORE is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, version 2.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright 2018-2021 by it's authors.
# Some rights reserved, see README and LICENSE.

import sys
from AccessControl import ClassSecurityInfo
from bika.lims import api
from bika.lims import bikaMessageFactory as _
from bika.lims.browser.widgets import ServicesWidget
from bika.lims.browser.widgets import WorksheetTemplateLayoutWidget
from bika.lims.config import ANALYSIS_TYPES
from bika.lims.config import PROJECTNAME
from bika.lims.content.bikaschema import BikaSchema
from bika.lims.interfaces import IDeactivable
from bika.lims.interfaces import IHaveInstrument
from bika.lims.interfaces import IWorksheetTemplate
from Products.Archetypes.public import BaseContent
from Products.Archetypes.public import BooleanField
from Products.Archetypes.public import BooleanWidget
from Products.Archetypes.public import DisplayList
from Products.Archetypes.public import ReferenceField
from Products.Archetypes.public import ReferenceWidget
from Products.Archetypes.public import registerType
from Products.Archetypes.public import Schema
from Products.Archetypes.public import StringField
from Products.Archetypes.public import StringWidget
from Products.Archetypes.references import HoldingReference
from senaite.core.browser.fields.records import RecordsField
from senaite.core.catalog import SETUP_CATALOG
from senaite.core.p3compat import cmp
from zope.interface import implements

schema = BikaSchema.copy() + Schema((
    RecordsField(
        "Layout",
        schemata="Layout",
        required=1,
        type="templateposition",
        subfields=("pos", "type", "blank_ref", "control_ref", "dup"),
        required_subfields=("pos", "type"),
        subfield_labels={
            "pos": _("Position"),
            "type": _("Analysis Type"),
            "blank_ref": _("Reference"),
            "control_ref": _("Reference"),
            "dup": _("Duplicate Of")
        },
        widget=WorksheetTemplateLayoutWidget(
            label=_("Worksheet Layout"),
            description=_(
                "Specify the size of the Worksheet, e.g. corresponding to a "
                "specific instrument's tray size. "
                "Then select an Analysis 'type' per Worksheet position."
                "Where QC samples are selected, also select which Reference "
                "Sample should be used."
                "If a duplicate analysis is selected, indicate which sample "
                "position it should be a duplicate of"),
        )
    ),

    ReferenceField(
        "Service",
        schemata="Analyses",
        required=0,
        multiValued=1,
        allowed_types=("AnalysisService",),
        relationship="WorksheetTemplateAnalysisService",
        referenceClass=HoldingReference,
        widget=ServicesWidget(
            label=_("Analysis Service"),
            description=_(
                "Select which Analyses should be included on the Worksheet"
            ),
        )
    ),

    ReferenceField(
        "RestrictToMethod",
        schemata="Description",
        required=0,
        vocabulary_display_path_bound=sys.maxint,
        vocabulary="_getMethodsVoc",
        allowed_types=("Method",),
        relationship="WorksheetTemplateMethod",
        referenceClass=HoldingReference,
        widget=ReferenceWidget(
            checkbox_bound=0,
            label=_("Method"),
            description=_(
                "Restrict the available analysis services and instruments"
                "to those with the selected method."
                " In order to apply this change to the services list, you "
                "should save the change first."
            ),
        ),
    ),

    ReferenceField(
        "Instrument",
        schemata="Description",
        required=0,
        vocabulary_display_path_bound=sys.maxint,
        vocabulary="getInstrumentsDisplayList",
        allowed_types=("Instrument",),
        relationship="WorksheetTemplateInstrument",
        referenceClass=HoldingReference,
        widget=ReferenceWidget(
            checkbox_bound=0,
            label=_("Instrument"),
            description=_(
                "Select the preferred instrument"
            ),
        ),
    ),

    StringField(
        "InstrumentTitle",
        widget=StringWidget(
            visible=False
        )
    ),

    BooleanField(
        "EnableMultipleUseOfInstrument",
        default=True,
        schemata="Description",
        widget=BooleanWidget(
            label=_("Enable Multiple Use of Instrument in Worksheets."),
            description=_(
                "If unchecked, Lab Managers won't be able to assign the same "
                "Instrument more than one Analyses while creating a Worksheet."
            )
        )
    ),

))

schema["title"].schemata = "Description"
schema["title"].widget.visible = True

schema["description"].schemata = "Description"
schema["description"].widget.visible = True


class WorksheetTemplate(BaseContent):
    """Worksheet Templates
    """
    implements(IWorksheetTemplate, IHaveInstrument, IDeactivable)
    security = ClassSecurityInfo()
    displayContentsTab = False
    schema = schema

    _at_rename_after_creation = True

    def _renameAfterCreation(self, check_auto_id=False):
        from bika.lims.idserver import renameAfterCreation
        renameAfterCreation(self)

    @security.public
    def getAnalysisTypes(self):
        """Return Analysis type displaylist
        """
        return ANALYSIS_TYPES

    @security.public
    def getInstrumentsDisplayList(self):
        """Returns a display list with the instruments that are allowed for
        this worksheet template based on the method selected, sorted by title
        ascending. It also includes "No instrument" as the first option
        """
        items = []
        for instrument in self.getInstruments():
            uid = api.get_uid(instrument)
            title = api.get_title(instrument)
            items.append((uid, title))

        # Sort them alphabetically by title
        items.sort(lambda x, y: cmp(x[1], y[1]))
        items.insert(0, ("", _("No instrument")))
        return DisplayList(items)

    def getInstruments(self):
        """Returns the list of active Instrument objects that are allowed for
        this worksheet template based on the method selected
        """
        uids = self.getRawInstruments()
        return [api.get_object_by_uid(uid) for uid in uids]

    def getRawInstruments(self):
        """Returns the list of UIDs from active instruments that are allowed
        for this worksheet template based on the method selected, if any
        """
        uids = []
        method_uid = self.getRawRestrictToMethod()
        query = {
            "portal_type": "Instrument",
            "is_active": True,
        }
        brains = api.search(query, SETUP_CATALOG)
        for brain in brains:
            uid = api.get_uid(brain)
            if not method_uid:
                uids.append(uid)
                continue

            # Restrict available instruments to those with the selected method
            instrument = api.get_object(brain)
            if method_uid in instrument.getRawMethods():
                uids.append(uid)

        return uids

    def getMethodUID(self):
        """Return method UID
        """
        method = self.getRestrictToMethod()
        if method:
            return method.UID()
        return ""

    def _getMethodsVoc(self):
        """Return the registered methods as DisplayList
        """
        methods = api.search({
            "portal_type": "Method",
            "is_active": True
        }, "senaite_catalog_setup")

        items = map(lambda m: (api.get_uid(m), api.get_title(m)), methods)
        items.sort(lambda x, y: cmp(x[1], y[1]))
        items.insert(0, ("", _("Not specified")))

        return DisplayList(list(items))


registerType(WorksheetTemplate, PROJECTNAME)


1			# -- coding: utf-8 --
2			#
3			# This file is part of SENAITE.CORE.
4			#
5			# SENAITE.CORE is free software: you can redistribute it and/or modify it under
6			# the terms of the GNU General Public License as published by the Free Software
7			# Foundation, version 2.
8			#
9			# This program is distributed in the hope that it will be useful, but WITHOUT
10			# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11			# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12			# details.
13			#
14			# You should have received a copy of the GNU General Public License along with
15			# this program; if not, write to the Free Software Foundation, Inc., 51
16			# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17			#
18			# Copyright 2018-2021 by it's authors.
19			# Some rights reserved, see README and LICENSE.
20
21			import sys
22			from AccessControl import ClassSecurityInfo
23			from bika.lims import api
24			from bika.lims import bikaMessageFactory as _
25			from bika.lims.browser.widgets import ServicesWidget
26			from bika.lims.browser.widgets import WorksheetTemplateLayoutWidget
27			from bika.lims.config import ANALYSIS_TYPES
28			from bika.lims.config import PROJECTNAME
29			from bika.lims.content.bikaschema import BikaSchema
30			from bika.lims.interfaces import IDeactivable
31			from bika.lims.interfaces import IHaveInstrument
32			from bika.lims.interfaces import IWorksheetTemplate
33			from Products.Archetypes.public import BaseContent
34			from Products.Archetypes.public import BooleanField
35			from Products.Archetypes.public import BooleanWidget
36			from Products.Archetypes.public import DisplayList
37			from Products.Archetypes.public import ReferenceField
38			from Products.Archetypes.public import ReferenceWidget
39			from Products.Archetypes.public import registerType
40			from Products.Archetypes.public import Schema
41			from Products.Archetypes.public import StringField
42			from Products.Archetypes.public import StringWidget
43			from Products.Archetypes.references import HoldingReference
44			from senaite.core.browser.fields.records import RecordsField
45			from senaite.core.catalog import SETUP_CATALOG
46			from senaite.core.p3compat import cmp
47			from zope.interface import implements
48
49			schema = BikaSchema.copy() + Schema((
50			RecordsField(
51			"Layout",
52			schemata="Layout",
53			required=1,
54			type="templateposition",
55			subfields=("pos", "type", "blank_ref", "control_ref", "dup"),
56			required_subfields=("pos", "type"),
57			subfield_labels={
58			"pos": _("Position"),
59			"type": _("Analysis Type"),
60			"blank_ref": _("Reference"),
61			"control_ref": _("Reference"),
62			"dup": _("Duplicate Of")
63			},
64			widget=WorksheetTemplateLayoutWidget(
65			label=_("Worksheet Layout"),
66			description=_(
67			"Specify the size of the Worksheet, e.g. corresponding to a "
68			"specific instrument's tray size. "
69			"Then select an Analysis 'type' per Worksheet position."
70			"Where QC samples are selected, also select which Reference "
71			"Sample should be used."
72			"If a duplicate analysis is selected, indicate which sample "
73			"position it should be a duplicate of"),
74			)
75			),
76
77			ReferenceField(
78			"Service",
79			schemata="Analyses",
80			required=0,
81			multiValued=1,
82			allowed_types=("AnalysisService",),
83			relationship="WorksheetTemplateAnalysisService",
84			referenceClass=HoldingReference,
85			widget=ServicesWidget(
86			label=_("Analysis Service"),
87			description=_(
88			"Select which Analyses should be included on the Worksheet"
89			),
90			)
91			),
92
93			ReferenceField(
94			"RestrictToMethod",
95			schemata="Description",
96			required=0,
97			vocabulary_display_path_bound=sys.maxint,
98			vocabulary="_getMethodsVoc",
99			allowed_types=("Method",),
100			relationship="WorksheetTemplateMethod",
101			referenceClass=HoldingReference,
102			widget=ReferenceWidget(
103			checkbox_bound=0,
104			label=_("Method"),
105			description=_(
106			"Restrict the available analysis services and instruments"
107			"to those with the selected method."
108			" In order to apply this change to the services list, you "
109			"should save the change first."
110			),
111			),
112			),
113
114			ReferenceField(
115			"Instrument",
116			schemata="Description",
117			required=0,
118			vocabulary_display_path_bound=sys.maxint,
119			vocabulary="getInstrumentsDisplayList",
120			allowed_types=("Instrument",),
121			relationship="WorksheetTemplateInstrument",
122			referenceClass=HoldingReference,
123			widget=ReferenceWidget(
124			checkbox_bound=0,
125			label=_("Instrument"),
126			description=_(
127			"Select the preferred instrument"
128			),
129			),
130			),
131
132			StringField(
133			"InstrumentTitle",
134			widget=StringWidget(
135			visible=False
136			)
137			),
138
139			BooleanField(
140			"EnableMultipleUseOfInstrument",
141			default=True,
142			schemata="Description",
143			widget=BooleanWidget(
144			label=_("Enable Multiple Use of Instrument in Worksheets."),
145			description=_(
146			"If unchecked, Lab Managers won't be able to assign the same "
147			"Instrument more than one Analyses while creating a Worksheet."
148			)
149			)
150			),
151
152			))
153
154			schema["title"].schemata = "Description"
155			schema["title"].widget.visible = True
156
157			schema["description"].schemata = "Description"
158			schema["description"].widget.visible = True
159
160
161			class WorksheetTemplate(BaseContent):
162			"""Worksheet Templates
163			"""
164			implements(IWorksheetTemplate, IHaveInstrument, IDeactivable)
165			security = ClassSecurityInfo()
166			displayContentsTab = False
167			schema = schema
			0 ignored issues – show Comprehensibility Best Practice introduced 2018-07-25 08:58 UTC by Report Bug Copy Issue Report The variable `schema` does not seem to be defined. Loading history...
168			_at_rename_after_creation = True
169
170			def _renameAfterCreation(self, check_auto_id=False):
171			from bika.lims.idserver import renameAfterCreation
172			renameAfterCreation(self)
173
174			@security.public
175			def getAnalysisTypes(self):
176			"""Return Analysis type displaylist
177			"""
178			return ANALYSIS_TYPES
179
180			@security.public
181			def getInstrumentsDisplayList(self):
182			"""Returns a display list with the instruments that are allowed for
183			this worksheet template based on the method selected, sorted by title
184			ascending. It also includes "No instrument" as the first option
185			"""
186			items = []
187			for instrument in self.getInstruments():
188			uid = api.get_uid(instrument)
189			title = api.get_title(instrument)
190			items.append((uid, title))
191
192			# Sort them alphabetically by title
193			items.sort(lambda x, y: cmp(x[1], y[1]))
194			items.insert(0, ("", _("No instrument")))
195			return DisplayList(items)
196
197			def getInstruments(self):
198			"""Returns the list of active Instrument objects that are allowed for
199			this worksheet template based on the method selected
200			"""
201			uids = self.getRawInstruments()
202			return [api.get_object_by_uid(uid) for uid in uids]
203
204			def getRawInstruments(self):
205			"""Returns the list of UIDs from active instruments that are allowed
206			for this worksheet template based on the method selected, if any
207			"""
208			uids = []
209			method_uid = self.getRawRestrictToMethod()
210			query = {
211			"portal_type": "Instrument",
212			"is_active": True,
213			}
214			brains = api.search(query, SETUP_CATALOG)
215			for brain in brains:
216			uid = api.get_uid(brain)
217			if not method_uid:
218			uids.append(uid)
219			continue
220
221			# Restrict available instruments to those with the selected method
222			instrument = api.get_object(brain)
223			if method_uid in instrument.getRawMethods():
224			uids.append(uid)
225
226			return uids
227
228			def getMethodUID(self):
229			"""Return method UID
230			"""
231			method = self.getRestrictToMethod()
232			if method:
233			return method.UID()
234			return ""
235
236			def _getMethodsVoc(self):
237			"""Return the registered methods as DisplayList
238			"""
239			methods = api.search({
240			"portal_type": "Method",
241			"is_active": True
242			}, "senaite_catalog_setup")
243
244			items = map(lambda m: (api.get_uid(m), api.get_title(m)), methods)
245			items.sort(lambda x, y: cmp(x[1], y[1]))
246			items.insert(0, ("", _("Not specified")))
247
248			return DisplayList(list(items))
249
250
251			registerType(WorksheetTemplate, PROJECTNAME)
252

senaite / senaite.core

Push — 2.x ( 7dbd5c...d2326f )

WorksheetTemplate._getMethodsVoc() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like