bika.lims.content.batch.Batch.getProgress() - Code Metrics - Inspection of "Progress indicator for Batch listing (#1544)" - senaite/senaite.core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 3d9c1d...19c3e0 )

by Jordi

created 2020-02-17 23:43 UTC

bika.lims.content.batch.Batch.getProgress() A

↳ Parent: bika.lims.content.batch

Complexity

Conditions

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	8
dl	0
loc	10
rs	10
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-2020 by it's authors.
# Some rights reserved, see README and LICENSE.

from AccessControl import ClassSecurityInfo
from bika.lims import api
from bika.lims import bikaMessageFactory as _
from bika.lims import deprecated
from bika.lims.browser.fields.remarksfield import RemarksField
from bika.lims.browser.widgets import DateTimeWidget
from bika.lims.browser.widgets import RecordsWidget as bikaRecordsWidget
from bika.lims.browser.widgets import ReferenceWidget
from bika.lims.browser.widgets import RemarksWidget
from bika.lims.catalog import CATALOG_ANALYSIS_REQUEST_LISTING
from bika.lims.config import PROJECTNAME
from bika.lims.content.bikaschema import BikaFolderSchema
from bika.lims.content.clientawaremixin import ClientAwareMixin
from bika.lims.interfaces import IBatch
from bika.lims.interfaces import ICancellable
from bika.lims.interfaces import IClient
from plone.app.folder.folder import ATFolder
from plone.indexer import indexer
from Products.Archetypes.public import DateTimeField
from Products.Archetypes.public import DisplayList
from Products.Archetypes.public import LinesField
from Products.Archetypes.public import MultiSelectionWidget
from Products.Archetypes.public import ReferenceField
from Products.Archetypes.public import Schema
from Products.Archetypes.public import StringField
from Products.Archetypes.public import StringWidget
from Products.Archetypes.public import registerType
from Products.Archetypes.references import HoldingReference
from Products.ATExtensions.ateapi import RecordsField
from Products.CMFCore.utils import getToolByName
from Products.CMFPlone.utils import safe_unicode
from zope.interface import implements


@indexer(IBatch)
def BatchDate(instance):
    return instance.Schema().getField('BatchDate').get(instance)


schema = BikaFolderSchema.copy() + Schema((

    StringField(
        'BatchID',
        required=False,
        validators=('uniquefieldvalidator',),
        widget=StringWidget(
            # XXX This field can never hold a user value, because it is
            #     invisible (see custom getBatchID getter method)
            # => we should remove that field
            visible=False,
            label=_("Batch ID"),
        )
    ),

    ReferenceField(
        'Client',
        required=0,
        allowed_types=('Client',),
        relationship='BatchClient',
        widget=ReferenceWidget(
            label=_("Client"),
            size=30,
            visible=True,
            base_query={'review_state': 'active'},
            showOn=True,
            colModel=[
                {'columnName': 'UID', 'hidden': True},
                {'columnName': 'Title', 'width': '60', 'label': _('Title')},
                {'columnName': 'ClientID', 'width': '20', 'label': _('Client ID')}
            ],
        ),
    ),

    StringField(
        'ClientBatchID',
        required=0,
        widget=StringWidget(
            label=_("Client Batch ID")
        )
    ),

    DateTimeField(
        'BatchDate',
        required=False,
        widget=DateTimeWidget(
            label=_('Date'),
        ),
    ),

    LinesField(
        'BatchLabels',
        vocabulary="BatchLabelVocabulary",
        accessor="getLabelNames",
        widget=MultiSelectionWidget(
            label=_("Batch Labels"),
            format="checkbox",
        )
    ),

    RemarksField(
        'Remarks',
        widget=RemarksWidget(
            label=_('Remarks'),
        )
    ),
))

# Remove implicit `uniquefieldvalidator` coming from `BikaFolderSchema`
schema['title'].validators = ()
schema['title'].widget.description = _("If no value is entered, the Batch ID"
                                       " will be auto-generated.")
schema['title'].required = False
schema['title'].widget.visible = True
schema['title'].widget.description = _("If no Title value is entered,"
                                       " the Batch ID will be used.")
schema['description'].required = False
schema['description'].widget.visible = True

schema.moveField('ClientBatchID', before='description')
schema.moveField('BatchID', before='description')
schema.moveField('title', before='description')
schema.moveField('Client', after='title')


class Batch(ATFolder, ClientAwareMixin):
    """A Batch combines multiple ARs into a logical unit
    """
    implements(IBatch, ICancellable)

    schema = schema

    displayContentsTab = False
    security = ClassSecurityInfo()
    _at_rename_after_creation = True

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

    def getClient(self):
        """Retrieves the Client the current Batch is assigned to
        """
        # We override here getClient from ClientAwareMixin because te schema's
        # field Client is only used to allow the user to assign the batch to a
        # client in edit form. The entered value is used in
        # ObjectModifiedEventHandler to move the batch to the Client's folder,
        # so the value stored in the Schema's is not used anymore
        # See https://github.com/senaite/senaite.core/pull/1450
        client = self.aq_parent
        if IClient.providedBy(client):
            return client
        return None

    def getContactTitle(self):
        return ""

    def getProfilesTitle(self):
        return ""

    def getAnalysisService(self):
        analyses = set()
        for ar in self.getAnalysisRequests():
            for an in ar.getAnalyses():
                analyses.add(an)
        value = []
        for analysis in analyses:
            val = analysis.Title
            if val not in value:
                value.append(val)
        return list(value)

    def getAnalysts(self):
        analyses = []
        for ar in self.getAnalysisRequests():
            analyses += list(ar.getAnalyses(full_objects=True))
        value = []
        for analysis in analyses:
            val = analysis.getAnalyst()
            if val not in value:
                value.append(val)
        return value

    security.declarePublic('getBatchID')

    @deprecated("Please use getId instead")
    def getBatchID(self):
        # NOTE This method is a custom getter of the invisible field "BatchID".
        #      Therefore, it is unlikely that it returns anything else than `getId`.
        if self.BatchID:
            return self.BatchID
        if self.checkCreationFlag():
            return self.BatchID
        return self.getId()

    def BatchLabelVocabulary(self):
        """Return all batch labels as a display list
        """
        bsc = getToolByName(self, 'bika_setup_catalog')
        ret = []
        for p in bsc(portal_type='BatchLabel',
                     is_active=True,
                     sort_on='sortable_title'):
            ret.append((p.UID, p.Title))
        return DisplayList(ret)

    def getAnalysisRequestsBrains(self, **kwargs):
        """Return all the Analysis Requests brains linked to the Batch
        kargs are passed directly to the catalog.
        """
        kwargs['getBatchUID'] = self.UID()
        catalog = getToolByName(self, CATALOG_ANALYSIS_REQUEST_LISTING)
        brains = catalog(kwargs)
        return brains

    def getAnalysisRequests(self, **kwargs):
        """Return all the Analysis Requests objects linked to the Batch kargs
        are passed directly to the catalog.
        """
        brains = self.getAnalysisRequestsBrains(**kwargs)
        return [b.getObject() for b in brains]

    def isOpen(self):
        """Returns true if the Batch is in 'open' state
        """
        return api.get_workflow_status_of(self) not in ["cancelled", "closed"]

    def getLabelNames(self):
        uc = getToolByName(self, 'uid_catalog')
        uids = [uid for uid in self.Schema().getField('BatchLabels').get(self)]
        labels = [label.getObject().title for label in uc(UID=uids)]
        return labels

    def getProgress(self):
        """Returns the progress in percent of all samples
        """
        total_progress = 0
        samples = self.getAnalysisRequests()
        total = len(samples)
        if total > 0:
            sample_progresses = map(lambda s: s.getProgress(), samples)
            total_progress = sum(sample_progresses) / total
        return total_progress


registerType(Batch, 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-2020 by it's authors.
19			# Some rights reserved, see README and LICENSE.
20
21			from AccessControl import ClassSecurityInfo
22			from bika.lims import api
23			from bika.lims import bikaMessageFactory as _
24			from bika.lims import deprecated
25			from bika.lims.browser.fields.remarksfield import RemarksField
26			from bika.lims.browser.widgets import DateTimeWidget
27			from bika.lims.browser.widgets import RecordsWidget as bikaRecordsWidget
28			from bika.lims.browser.widgets import ReferenceWidget
29			from bika.lims.browser.widgets import RemarksWidget
30			from bika.lims.catalog import CATALOG_ANALYSIS_REQUEST_LISTING
31			from bika.lims.config import PROJECTNAME
32			from bika.lims.content.bikaschema import BikaFolderSchema
33			from bika.lims.content.clientawaremixin import ClientAwareMixin
34			from bika.lims.interfaces import IBatch
35			from bika.lims.interfaces import ICancellable
36			from bika.lims.interfaces import IClient
37			from plone.app.folder.folder import ATFolder
38			from plone.indexer import indexer
39			from Products.Archetypes.public import DateTimeField
40			from Products.Archetypes.public import DisplayList
41			from Products.Archetypes.public import LinesField
42			from Products.Archetypes.public import MultiSelectionWidget
43			from Products.Archetypes.public import ReferenceField
44			from Products.Archetypes.public import Schema
45			from Products.Archetypes.public import StringField
46			from Products.Archetypes.public import StringWidget
47			from Products.Archetypes.public import registerType
48			from Products.Archetypes.references import HoldingReference
49			from Products.ATExtensions.ateapi import RecordsField
50			from Products.CMFCore.utils import getToolByName
51			from Products.CMFPlone.utils import safe_unicode
52			from zope.interface import implements
53
54
55			@indexer(IBatch)
56			def BatchDate(instance):
57			return instance.Schema().getField('BatchDate').get(instance)
58
59
60			schema = BikaFolderSchema.copy() + Schema((
61
62			StringField(
63			'BatchID',
64			required=False,
65			validators=('uniquefieldvalidator',),
66			widget=StringWidget(
67			# XXX This field can never hold a user value, because it is
68			# invisible (see custom getBatchID getter method)
69			# => we should remove that field
70			visible=False,
71			label=_("Batch ID"),
72			)
73			),
74
75			ReferenceField(
76			'Client',
77			required=0,
78			allowed_types=('Client',),
79			relationship='BatchClient',
80			widget=ReferenceWidget(
81			label=_("Client"),
82			size=30,
83			visible=True,
84			base_query={'review_state': 'active'},
85			showOn=True,
86			colModel=[
87			{'columnName': 'UID', 'hidden': True},
88			{'columnName': 'Title', 'width': '60', 'label': _('Title')},
89			{'columnName': 'ClientID', 'width': '20', 'label': _('Client ID')}
90			],
91			),
92			),
93
94			StringField(
95			'ClientBatchID',
96			required=0,
97			widget=StringWidget(
98			label=_("Client Batch ID")
99			)
100			),
101
102			DateTimeField(
103			'BatchDate',
104			required=False,
105			widget=DateTimeWidget(
106			label=_('Date'),
107			),
108			),
109
110			LinesField(
111			'BatchLabels',
112			vocabulary="BatchLabelVocabulary",
113			accessor="getLabelNames",
114			widget=MultiSelectionWidget(
115			label=_("Batch Labels"),
116			format="checkbox",
117			)
118			),
119
120			RemarksField(
121			'Remarks',
122			widget=RemarksWidget(
123			label=_('Remarks'),
124			)
125			),
126			))
127
128			# Remove implicit `uniquefieldvalidator` coming from `BikaFolderSchema`
129			schema['title'].validators = ()
130			schema['title'].widget.description = _("If no value is entered, the Batch ID"
131			" will be auto-generated.")
132			schema['title'].required = False
133			schema['title'].widget.visible = True
134			schema['title'].widget.description = _("If no Title value is entered,"
135			" the Batch ID will be used.")
136			schema['description'].required = False
137			schema['description'].widget.visible = True
138
139			schema.moveField('ClientBatchID', before='description')
140			schema.moveField('BatchID', before='description')
141			schema.moveField('title', before='description')
142			schema.moveField('Client', after='title')
143
144
145			class Batch(ATFolder, ClientAwareMixin):
146			"""A Batch combines multiple ARs into a logical unit
147			"""
148			implements(IBatch, ICancellable)
149
150			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...
151			displayContentsTab = False
152			security = ClassSecurityInfo()
153			_at_rename_after_creation = True
154
155			def _renameAfterCreation(self, check_auto_id=False):
156			from bika.lims.idserver import renameAfterCreation
157			renameAfterCreation(self)
158
159			def getClient(self):
160			"""Retrieves the Client the current Batch is assigned to
161			"""
162			# We override here getClient from ClientAwareMixin because te schema's
163			# field Client is only used to allow the user to assign the batch to a
164			# client in edit form. The entered value is used in
165			# ObjectModifiedEventHandler to move the batch to the Client's folder,
166			# so the value stored in the Schema's is not used anymore
167			# See https://github.com/senaite/senaite.core/pull/1450
168			client = self.aq_parent
169			if IClient.providedBy(client):
170			return client
171			return None
172
173			def getContactTitle(self):
174			return ""
175
176			def getProfilesTitle(self):
177			return ""
178
179			def getAnalysisService(self):
180			analyses = set()
181			for ar in self.getAnalysisRequests():
182			for an in ar.getAnalyses():
183			analyses.add(an)
184			value = []
185			for analysis in analyses:
186			val = analysis.Title
187			if val not in value:
188			value.append(val)
189			return list(value)
190
191			def getAnalysts(self):
192			analyses = []
193			for ar in self.getAnalysisRequests():
194			analyses += list(ar.getAnalyses(full_objects=True))
195			value = []
196			for analysis in analyses:
197			val = analysis.getAnalyst()
198			if val not in value:
199			value.append(val)
200			return value
201
202			security.declarePublic('getBatchID')
203
204			@deprecated("Please use getId instead")
205			def getBatchID(self):
206			# NOTE This method is a custom getter of the invisible field "BatchID".
207			# Therefore, it is unlikely that it returns anything else than `getId`.
208			if self.BatchID:
209			return self.BatchID
210			if self.checkCreationFlag():
211			return self.BatchID
212			return self.getId()
213
214			def BatchLabelVocabulary(self):
215			"""Return all batch labels as a display list
216			"""
217			bsc = getToolByName(self, 'bika_setup_catalog')
218			ret = []
219			for p in bsc(portal_type='BatchLabel',
220			is_active=True,
221			sort_on='sortable_title'):
222			ret.append((p.UID, p.Title))
223			return DisplayList(ret)
224
225			def getAnalysisRequestsBrains(self, **kwargs):
226			"""Return all the Analysis Requests brains linked to the Batch
227			kargs are passed directly to the catalog.
228			"""
229			kwargs['getBatchUID'] = self.UID()
230			catalog = getToolByName(self, CATALOG_ANALYSIS_REQUEST_LISTING)
231			brains = catalog(kwargs)
232			return brains
233
234			def getAnalysisRequests(self, **kwargs):
235			"""Return all the Analysis Requests objects linked to the Batch kargs
236			are passed directly to the catalog.
237			"""
238			brains = self.getAnalysisRequestsBrains(**kwargs)
239			return [b.getObject() for b in brains]
240
241			def isOpen(self):
242			"""Returns true if the Batch is in 'open' state
243			"""
244			return api.get_workflow_status_of(self) not in ["cancelled", "closed"]
245
246			def getLabelNames(self):
247			uc = getToolByName(self, 'uid_catalog')
248			uids = [uid for uid in self.Schema().getField('BatchLabels').get(self)]
249			labels = [label.getObject().title for label in uc(UID=uids)]
250			return labels
251
252			def getProgress(self):
253			"""Returns the progress in percent of all samples
254			"""
255			total_progress = 0
256			samples = self.getAnalysisRequests()
257			total = len(samples)
258			if total > 0:
259			sample_progresses = map(lambda s: s.getProgress(), samples)
260			total_progress = sum(sample_progresses) / total
261			return total_progress
262
263
264			registerType(Batch, PROJECTNAME)
265

senaite / senaite.core

Push — master ( 3d9c1d...19c3e0 )

bika.lims.content.batch.Batch.getProgress() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like