JsonFile.byLocation() - Code Metrics - Inspection of "Full text search" - ilogue/niprov - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#144)

by Jasper

created 2016-06-24 23:56 UTC

JsonFile.byLocation() B

↳ Parent: JsonFile

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
dl	0
loc	20
rs	8
c	0
b	0
f	0

import os
from operator import itemgetter
from niprov.dependencies import Dependencies


class JsonFile(object):
    """Stores provenance in a local text file encoded as json.
    """

    def __init__(self, dependencies=Dependencies()):
        self.filesys = dependencies.getFilesystem()
        self.json = dependencies.getSerializer()
        self.factory = dependencies.getFileFactory()
        self.pictureCache = dependencies.getPictureCache()
        url = dependencies.getConfiguration().database_url
        self.datafile = os.path.expanduser(url)

    def serializeAndWrite(self, images):
        jsonstr = self.json.serializeList(images)
        self.filesys.write(self.datafile, jsonstr)

    def add(self, image):
        """Add the provenance for one file to storage.

        Args:
            image (:class:`.BaseFile`): Image file to store.
        """
        current = self.all()
        current.append(image)
        self.serializeAndWrite(current)
        self.pictureCache.saveToDisk(for_=image)

    def update(self, image):
        """Save changed provenance for this file..

        Args:
            image (:class:`.BaseFile`): Image file that has changed.
        """
        current = self.all()
        for r in range(len(current)):
            if current[r].location.toString() == image.location.toString():
                current[r] = image
        self.serializeAndWrite(current)

    def all(self):
        """Retrieve all known provenance from storage.

        Returns:
            list: List of provenance for known files.
        """
        try:
            jsonstr = self.filesys.read(self.datafile)
        except IOError:
            return []
        return self.json.deserializeList(jsonstr)

    def knowsByLocation(self, locationString):
        """Whether the file at this path has provenance associated with it.

        Returns:
            bool: True if provenance is available for that path.
        """
        try:
            self.byLocation(locationString)
        except IndexError:
            return False
        return True

    def knows(self, image):
        """Whether this file has provenance associated with it.

        Returns:
            bool: True if provenance is available for this image.
        """
        try:
            self.byLocation(image.path)
        except IndexError:
            return False
        return True

    def knowsSeries(self, image):
        """Whether the series that this file is part of has provenance 
        associated with it.

        Args:
            image (:class:`.BaseFile`): File for which the series is sought.

        Returns:
            bool: True if provenance is available for this series.
        """
        try:
            self.getSeries(image)
        except IndexError:
            return False
        return True

    def byLocation(self, locationString):
        """Get the provenance for a file at the given location. 

        In the case of a dicom series, this returns the provenance for the 
        series.

        Args:
            locationString (str): Location of the image file.

        Returns:
            dict: Provenance for one image file.
        """
        for image in self.all():
            if image.location.toString() == locationString:
                return image
            elif 'filesInSeries' in image.provenance and (
                locationString in image.provenance['filesInSeries']):
                return image
        else:
            raise IndexError('No file with that path known.')

    def byLocations(self, listOfLocations):
        return [f for f in self.all() if f.location.toString() in listOfLocations]

    def getSeries(self, image):
        """Get the object that carries provenance for the series that the image 
        passed is in. 

        Args:
            image (:class:`.DicomFile`): File that is part of a series.

        Returns:
            :class:`.DicomFile`: Image object that caries provenance for the series.
        """
        if image.getSeriesId() is None:
            raise IndexError('Image has no series id.')
        seriesId = image.getSeriesId()
        for image in self.all():
            if 'seriesuid' in image.provenance and (
                image.provenance['seriesuid'] == seriesId):
                return image
        else:
            raise IndexError('No provenance record for that series.')

    def updateApproval(self, fpath, approvalStatus):
        img = self.byLocation(fpath)
        img.provenance['approval'] = approvalStatus
        self.update(img)

    def latest(self, n=20):
        def dateTimeAdded(img):
            return img.provenance.get('added')
        sortedImages = sorted(self.all(), key=dateTimeAdded, reverse=True)
        return sortedImages[:n]

    def statistics(self):
        stats = {}
        images = self.all()
        stats['count'] = len(images)
        sizes = [img.provenance['size'] for img in images if 'size' in img.provenance]
        stats['totalsize'] = sum(sizes)
        return stats

    def byId(self, uid):
        for image in self.all():
            if image.provenance['id'] == uid:
                return image
        else:
            raise IndexError('No file with that path known.')

    def byParents(self, listOfParentLocations):
        return [f for f in self.all() if set(listOfParentLocations).intersection(
            f.provenance.get('parents',[]))]

    def inquire(self, query):
        field = query.getFields()[0]
        matches = []
        for image in self.all():
            if field.name in image.provenance:
                if image.provenance[field.name] == field.value:
                    matches.append(image)
        return matches

    def search(self, text):
        fields = ['location','user','subject','project','protocol',
                  'transformation','technique','modality']
        matches = []
        for image in self.all():
            score = 0
            for word in text.split():
                for field in fields:
                    if field in image.provenance:
                        score += image.provenance[field].count(word)
            if score > 0:
                matches.append((image, score))
        sortedResults = sorted(matches, key=itemgetter(1), reverse=True)
        return [i for i, s in sortedResults[:20]]
        



1			import os
2			from operator import itemgetter
3			from niprov.dependencies import Dependencies
4
5
6			class JsonFile(object):
7			"""Stores provenance in a local text file encoded as json.
8			"""
9
10			def __init__(self, dependencies=Dependencies()):
11			self.filesys = dependencies.getFilesystem()
12			self.json = dependencies.getSerializer()
13			self.factory = dependencies.getFileFactory()
14			self.pictureCache = dependencies.getPictureCache()
15			url = dependencies.getConfiguration().database_url
16			self.datafile = os.path.expanduser(url)
17
18			def serializeAndWrite(self, images):
19			jsonstr = self.json.serializeList(images)
20			self.filesys.write(self.datafile, jsonstr)
21
22			def add(self, image):
23			"""Add the provenance for one file to storage.
24
25			Args:
26			image (:class:`.BaseFile`): Image file to store.
27			"""
28			current = self.all()
29			current.append(image)
30			self.serializeAndWrite(current)
31			self.pictureCache.saveToDisk(for_=image)
32
33			def update(self, image):
34			"""Save changed provenance for this file..
35
36			Args:
37			image (:class:`.BaseFile`): Image file that has changed.
38			"""
39			current = self.all()
40			for r in range(len(current)):
41			if current[r].location.toString() == image.location.toString():
42			current[r] = image
43			self.serializeAndWrite(current)
44
45			def all(self):
46			"""Retrieve all known provenance from storage.
47
48			Returns:
49			list: List of provenance for known files.
50			"""
51			try:
52			jsonstr = self.filesys.read(self.datafile)
53			except IOError:
54			return []
55			return self.json.deserializeList(jsonstr)
56
57			def knowsByLocation(self, locationString):
58			"""Whether the file at this path has provenance associated with it.
59
60			Returns:
61			bool: True if provenance is available for that path.
62			"""
63			try:
64			self.byLocation(locationString)
65			except IndexError:
66			return False
67			return True
68
69			def knows(self, image):
70			"""Whether this file has provenance associated with it.
71
72			Returns:
73			bool: True if provenance is available for this image.
74			"""
75			try:
76			self.byLocation(image.path)
77			except IndexError:
78			return False
79			return True
80
81			def knowsSeries(self, image):
82			"""Whether the series that this file is part of has provenance
83			associated with it.
84
85			Args:
86			image (:class:`.BaseFile`): File for which the series is sought.
87
88			Returns:
89			bool: True if provenance is available for this series.
90			"""
91			try:
92			self.getSeries(image)
93			except IndexError:
94			return False
95			return True
96
97			def byLocation(self, locationString):
98			"""Get the provenance for a file at the given location.
99
100			In the case of a dicom series, this returns the provenance for the
101			series.
102
103			Args:
104			locationString (str): Location of the image file.
105
106			Returns:
107			dict: Provenance for one image file.
108			"""
109			for image in self.all():
110			if image.location.toString() == locationString:
111			return image
112			elif 'filesInSeries' in image.provenance and (
113			locationString in image.provenance['filesInSeries']):
114			return image
115			else:
116			raise IndexError('No file with that path known.')
117
118			def byLocations(self, listOfLocations):
119			return [f for f in self.all() if f.location.toString() in listOfLocations]
120
121			def getSeries(self, image):
122			"""Get the object that carries provenance for the series that the image
123			passed is in.
124
125			Args:
126			image (:class:`.DicomFile`): File that is part of a series.
127
128			Returns:
129			:class:`.DicomFile`: Image object that caries provenance for the series.
130			"""
131			if image.getSeriesId() is None:
132			raise IndexError('Image has no series id.')
133			seriesId = image.getSeriesId()
134			for image in self.all():
135			if 'seriesuid' in image.provenance and (
136			image.provenance['seriesuid'] == seriesId):
137			return image
138			else:
139			raise IndexError('No provenance record for that series.')
140
141			def updateApproval(self, fpath, approvalStatus):
142			img = self.byLocation(fpath)
143			img.provenance['approval'] = approvalStatus
144			self.update(img)
145
146			def latest(self, n=20):
147			def dateTimeAdded(img):
148			return img.provenance.get('added')
149			sortedImages = sorted(self.all(), key=dateTimeAdded, reverse=True)
150			return sortedImages[:n]
151
152			def statistics(self):
153			stats = {}
154			images = self.all()
155			stats['count'] = len(images)
156			sizes = [img.provenance['size'] for img in images if 'size' in img.provenance]
157			stats['totalsize'] = sum(sizes)
158			return stats
159
160			def byId(self, uid):
161			for image in self.all():
162			if image.provenance['id'] == uid:
163			return image
164			else:
165			raise IndexError('No file with that path known.')
166
167			def byParents(self, listOfParentLocations):
168			return [f for f in self.all() if set(listOfParentLocations).intersection(
169			f.provenance.get('parents',[]))]
170
171			def inquire(self, query):
172			field = query.getFields()[0]
173			matches = []
174			for image in self.all():
175			if field.name in image.provenance:
176			if image.provenance[field.name] == field.value:
177			matches.append(image)
178			return matches
179
180			def search(self, text):
181			fields = ['location','user','subject','project','protocol',
182			'transformation','technique','modality']
183			matches = []
184			for image in self.all():
185			score = 0
186			for word in text.split():
187			for field in fields:
188			if field in image.provenance:
189			score += image.provenance[field].count(word)
190			if score > 0:
191			matches.append((image, score))
192			sortedResults = sorted(matches, key=itemgetter(1), reverse=True)
193			return [i for i, s in sortedResults[:20]]
194
195
196

ilogue / niprov

Pull Request — master (#144)

JsonFile.byLocation() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like