From b04a6bba790f9a7fed7319a8a05cd948b7e92668 Mon Sep 17 00:00:00 2001 From: Tim Bentley Date: Mon, 21 Jan 2013 07:29:43 +0000 Subject: [PATCH] Code tidy ups to make pylint happier --- openlp/core/lib/serviceitem.py | 14 +-- openlp/core/ui/servicemanager.py | 88 +++++++++---------- openlp/core/ui/slidecontroller.py | 3 +- openlp/plugins/custom/lib/mediaitem.py | 4 +- openlp/plugins/remotes/lib/httpserver.py | 14 +-- openlp/plugins/songs/lib/mediaitem.py | 2 +- .../openlp_core_lib/test_serviceitem.py | 1 - 7 files changed, 62 insertions(+), 64 deletions(-) diff --git a/openlp/core/lib/serviceitem.py b/openlp/core/lib/serviceitem.py index 4c0d638d4..01d91273a 100644 --- a/openlp/core/lib/serviceitem.py +++ b/openlp/core/lib/serviceitem.py @@ -161,7 +161,7 @@ class ServiceItem(object): self.service_item_type = None self._raw_frames = [] self._display_frames = [] - self._uuid = 0 + self.unique_identifyer = 0 self.notes = u'' self.from_plugin = False self.capabilities = [] @@ -195,7 +195,7 @@ class ServiceItem(object): Method to set the internal id of the item. This is used to compare service items to see if they are the same. """ - self._uuid = unicode(uuid.uuid1()) + self.unique_identifyer = unicode(uuid.uuid1()) self.validate_item() def add_capability(self, capability): @@ -454,14 +454,14 @@ class ServiceItem(object): def merge(self, other): """ - Updates the _uuid with the value from the original one - The _uuid is unique for a given service item but this allows one to + Updates the unique_identifyer with the value from the original one + The unique_identifyer is unique for a given service item but this allows one to replace an original version. ``other`` The service item to be merged with """ - self._uuid = other._uuid + self.unique_identifyer = other.unique_identifyer self.notes = other.notes self.temporary_edit = other.temporary_edit # Copy theme over if present. @@ -478,13 +478,13 @@ class ServiceItem(object): """ if not other: return False - return self._uuid == other._uuid + return self.unique_identifyer == other.unique_identifyer def __ne__(self, other): """ Confirms the service items are not for the same instance """ - return self._uuid != other._uuid + return self.unique_identifyer != other.unique_identifyer def is_media(self): """ diff --git a/openlp/core/ui/servicemanager.py b/openlp/core/ui/servicemanager.py index 8a9b01d04..8f399cadc 100644 --- a/openlp/core/ui/servicemanager.py +++ b/openlp/core/ui/servicemanager.py @@ -110,7 +110,7 @@ class ServiceManager(QtGui.QWidget): self.suffixes = [] self.dropPosition = 0 self.expandTabs = False - self.serviceId = 0 + self.service_id = 0 # is a new service and has not been saved self._modified = False self._fileName = u'' @@ -165,8 +165,7 @@ class ServiceManager(QtGui.QWidget): # Add the bottom toolbar self.orderToolbar = OpenLPToolbar(self) action_list = ActionList.get_instance() - action_list.add_category( - UiStrings().Service, CategoryOrder.standardToolbar) + action_list.add_category(UiStrings().Service, CategoryOrder.standardToolbar) self.serviceManagerList.moveTop = self.orderToolbar.addToolbarAction(u'moveTop', text=translate('OpenLP.ServiceManager', 'Move to &top'), icon=u':/services/service_top.png', tooltip=translate('OpenLP.ServiceManager', 'Move item to the top of the service.'), @@ -297,7 +296,7 @@ class ServiceManager(QtGui.QWidget): has been modified. """ if modified: - self.serviceId += 1 + self.service_id += 1 self._modified = modified serviceFile = self.shortFileName() or translate('OpenLP.ServiceManager', 'Untitled Service') self.mainwindow.setServiceModified(modified, serviceFile) @@ -411,7 +410,7 @@ class ServiceManager(QtGui.QWidget): self.serviceManagerList.clear() self.serviceItems = [] self.setFileName(u'') - self.serviceId += 1 + self.service_id += 1 self.setModified(False) Settings().setValue(u'servicemanager/last file', u'') Receiver.send_message(u'servicemanager_new_service') @@ -480,33 +479,33 @@ class ServiceManager(QtGui.QWidget): if service_item[u'header'][u'background_audio']: for i, filename in enumerate( service_item[u'header'][u'background_audio']): - new_file = os.path.join(u'audio', - item[u'service_item']._uuid, filename) + new_file_item= os.path.join(u'audio', + item[u'service_item'].unique_identifyer, filename) audio_files.append((filename, new_file)) service_item[u'header'][u'background_audio'][i] = new_file # Add the service item to the service. service.append({u'serviceitem': service_item}) self.repaintServiceList(-1, -1) - for file in write_list: - file_size = os.path.getsize(file) + for file_item in write_list: + file_size = os.path.getsize(file_item) total_size += file_size - log.debug(u'ServiceManager.saveFile - ZIP contents size is %i bytes' % total_size) + log.debug(u'ServiceManager.savefile_item - ZIP contents size is %i bytes' % total_size) service_content = cPickle.dumps(service) # Usual Zip file cannot exceed 2GiB, file with Zip64 cannot be # extracted using unzip in UNIX. allow_zip_64 = (total_size > 2147483648 + len(service_content)) log.debug(u'ServiceManager.saveFile - allowZip64 is %s' % allow_zip_64) - zip = None + zip_file = None success = True self.mainwindow.incrementProgressBar() try: - zip = zipfile.ZipFile(temp_file_name, 'w', zipfile.ZIP_STORED, allow_zip_64) + zip_file = zipfile.ZipFile(temp_file_name, 'w', zipfile.ZIP_STORED, allow_zip_64) # First we add service contents. # We save ALL filenames into ZIP using UTF-8. - zip.writestr(service_file_name.encode(u'utf-8'), service_content) + zip_file.writestr(service_file_name.encode(u'utf-8'), service_content) # Finally add all the listed media files. for write_from in write_list: - zip.write(write_from, write_from.encode(u'utf-8')) + zip_file.write(write_from, write_from.encode(u'utf-8')) for audio_from, audio_to in audio_files: if audio_from.startswith(u'audio'): # When items are saved, they get new UUID's. Let's copy the @@ -519,7 +518,7 @@ class ServiceManager(QtGui.QWidget): check_directory_exists(save_path) if not os.path.exists(save_file): shutil.copy(audio_from, save_file) - zip.write(audio_from, audio_to.encode(u'utf-8')) + zip_file.write(audio_from, audio_to.encode(u'utf-8')) except IOError: log.exception(u'Failed to save service to disk: %s', temp_file_name) Receiver.send_message(u'openlp_error_message', { @@ -528,8 +527,8 @@ class ServiceManager(QtGui.QWidget): }) success = False finally: - if zip: - zip.close() + if zip_file: + zip_file.close() self.mainwindow.finishedProgressBar() Receiver.send_message(u'cursor_normal') if success: @@ -574,14 +573,14 @@ class ServiceManager(QtGui.QWidget): service.append({u'serviceitem': service_item}) self.mainwindow.incrementProgressBar() service_content = cPickle.dumps(service) - zip = None + zip_file = None success = True self.mainwindow.incrementProgressBar() try: - zip = zipfile.ZipFile(temp_file_name, 'w', zipfile.ZIP_STORED, + zip_file = zipfile.ZipFile(temp_file_name, 'w', zipfile.ZIP_STORED, True) # First we add service contents. - zip.writestr(service_file_name.encode(u'utf-8'), service_content) + zip_file.writestr(service_file_name.encode(u'utf-8'), service_content) except IOError: log.exception(u'Failed to save service to disk: %s', temp_file_name) Receiver.send_message(u'openlp_error_message', { @@ -590,8 +589,8 @@ class ServiceManager(QtGui.QWidget): }) success = False finally: - if zip: - zip.close() + if zip_file: + zip_file.close() self.mainwindow.finishedProgressBar() Receiver.send_message(u'cursor_normal') if success: @@ -709,11 +708,11 @@ class ServiceManager(QtGui.QWidget): else: serviceItem.set_from_service(item, self.servicePath) serviceItem.validate_item(self.suffixes) - self.load_item_uuid = 0 + self.load_item_unique_identifyer = 0 if serviceItem.is_capable(ItemCapabilities.OnLoadUpdate): Receiver.send_message(u'%s_service_load' % serviceItem.name.lower(), serviceItem) # if the item has been processed - if serviceItem._uuid == self.load_item_uuid: + if serviceItem.unique_identifyer == self.load_item_unique_identifyer: serviceItem.edit_id = int(self.load_item_edit_id) serviceItem.temporary_edit = self.load_item_temporary self.addServiceItem(serviceItem, repaint=False) @@ -919,9 +918,9 @@ class ServiceManager(QtGui.QWidget): Called by the SlideController to request a preview item be made live and allows the next preview to be updated if relevant. """ - uuid, row = message.split(u':') + unique_identifyer, row = message.split(u':') for sitem in self.serviceItems: - if sitem[u'service_item']._uuid == uuid: + if sitem[u'service_item'].unique_identifyer == unique_identifyer: item = self.serviceManagerList.topLevelItem(sitem[u'order'] - 1) self.serviceManagerList.setCurrentItem(item) self.makeLive(int(row)) @@ -1124,7 +1123,7 @@ class ServiceManager(QtGui.QWidget): self.service_has_all_original_files = False # Repaint the screen self.serviceManagerList.clear() - for itemcount, item in enumerate(self.serviceItems): + for item_count, item in enumerate(self.serviceItems): serviceitem = item[u'service_item'] treewidgetitem = QtGui.QTreeWidgetItem(self.serviceManagerList) if serviceitem.is_valid: @@ -1173,7 +1172,7 @@ class ServiceManager(QtGui.QWidget): text = frame[u'title'].replace(u'\n', u' ') child.setText(0, text[:40]) child.setData(0, QtCore.Qt.UserRole, count) - if serviceItem == itemcount: + if serviceItem == item_count: if item[u'expanded'] and serviceItemChild == count: self.serviceManagerList.setCurrentItem(child) elif serviceItemChild == -1: @@ -1255,7 +1254,7 @@ class ServiceManager(QtGui.QWidget): Triggered from plugins to update service items. Save the values as they will be used as part of the service load """ - edit_id, self.load_item_uuid, temporary = message.split(u':') + edit_id, self.load_item_unique_identifyer, temporary = message.split(u':') self.load_item_edit_id = int(edit_id) self.load_item_temporary = str_to_bool(temporary) @@ -1264,12 +1263,12 @@ class ServiceManager(QtGui.QWidget): Using the service item passed replace the one with the same edit id if found. """ - for itemcount, item in enumerate(self.serviceItems): + for item_count, item in enumerate(self.serviceItems): if item[u'service_item'].edit_id == newItem.edit_id and item[u'service_item'].name == newItem.name: newItem.render() newItem.merge(item[u'service_item']) item[u'service_item'] = newItem - self.repaintServiceList(itemcount + 1, 0) + self.repaintServiceList(item_count + 1, 0) self.mainwindow.liveController.replaceServiceManagerItem(newItem) self.setModified() @@ -1326,8 +1325,7 @@ class ServiceManager(QtGui.QWidget): Receiver.send_message(u'cursor_busy') item, child = self.findServiceItem() if self.serviceItems[item][u'service_item'].is_valid: - self.mainwindow.previewController.addServiceManagerItem( - self.serviceItems[item][u'service_item'], child) + self.mainwindow.previewController.addServiceManagerItem(self.serviceItems[item][u'service_item'], child) else: critical_error_message_box(translate('OpenLP.ServiceManager', 'Missing Display Handler'), translate('OpenLP.ServiceManager', @@ -1412,11 +1410,11 @@ class ServiceManager(QtGui.QWidget): serviceItem = -1 serviceItemChild = -1 for item in items: - parentitem = item.parent() - if parentitem is None: + parent_item = item.parent() + if parent_item is None: serviceItem = item.data(0, QtCore.Qt.UserRole) else: - serviceItem = parentitem.data(0, QtCore.Qt.UserRole) + serviceItem = parent_item.data(0, QtCore.Qt.UserRole) serviceItemChild = item.data(0, QtCore.Qt.UserRole) # Adjust for zero based arrays. serviceItem -= 1 @@ -1465,7 +1463,7 @@ class ServiceManager(QtGui.QWidget): if item is None: endpos = len(self.serviceItems) else: - endpos = self._getParentItemData(item) - 1 + endpos = self._getparent_itemData(item) - 1 serviceItem = self.serviceItems[startpos] self.serviceItems.remove(serviceItem) self.serviceItems.insert(endpos, serviceItem) @@ -1478,21 +1476,21 @@ class ServiceManager(QtGui.QWidget): self.dropPosition = len(self.serviceItems) else: # we are over something so lets investigate - pos = self._getParentItemData(item) - 1 + pos = self._getparent_itemData(item) - 1 serviceItem = self.serviceItems[pos] if (plugin == serviceItem[u'service_item'].name and serviceItem[u'service_item'].is_capable(ItemCapabilities.CanAppend)): action = self.dndMenu.exec_(QtGui.QCursor.pos()) # New action required if action == self.newAction: - self.dropPosition = self._getParentItemData(item) + self.dropPosition = self._getparent_itemData(item) # Append to existing action if action == self.addToAction: - self.dropPosition = self._getParentItemData(item) + self.dropPosition = self._getparent_itemData(item) item.setSelected(True) replace = True else: - self.dropPosition = self._getParentItemData(item) + self.dropPosition = self._getparent_itemData(item) Receiver.send_message(u'%s_add_service_item' % plugin, replace) def updateThemeList(self, theme_list): @@ -1532,12 +1530,12 @@ class ServiceManager(QtGui.QWidget): self.serviceItems[item][u'service_item'].update_theme(theme) self.regenerateServiceItems(True) - def _getParentItemData(self, item): - parentitem = item.parent() - if parentitem is None: + def _getparent_itemData(self, item): + parent_item = item.parent() + if parent_item is None: return item.data(0, QtCore.Qt.UserRole) else: - return parentitem.data(0, QtCore.Qt.UserRole) + return parent_item.data(0, QtCore.Qt.UserRole) def printServiceOrder(self): """ diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index 7e6879bdf..c26a035ec 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -1218,7 +1218,8 @@ class SlideController(DisplayController): row = self.previewListWidget.currentRow() if -1 < row < self.previewListWidget.rowCount(): if self.serviceItem.from_service: - Receiver.send_message('servicemanager_preview_live', u'%s:%s' % (self.serviceItem._uuid, row)) + Receiver.send_message('servicemanager_preview_live', u'%s:%s' % + (self.serviceItem.unique_identifyer, row)) else: self.parent().liveController.addServiceManagerItem(self.serviceItem, row) diff --git a/openlp/plugins/custom/lib/mediaitem.py b/openlp/plugins/custom/lib/mediaitem.py index f9478d6ff..bc5dc41e4 100644 --- a/openlp/plugins/custom/lib/mediaitem.py +++ b/openlp/plugins/custom/lib/mediaitem.py @@ -258,7 +258,7 @@ class CustomMediaItem(MediaManagerItem): and_(CustomSlide.title == item.title, CustomSlide.theme_name == item.theme, CustomSlide.credits == item.raw_footer[0][len(item.title) + 1:])) if custom: - Receiver.send_message(u'service_item_update', u'%s:%s:%s' % (custom.id, item._uuid, False)) + Receiver.send_message(u'service_item_update', u'%s:%s:%s' % (custom.id, item.unique_identifyer, False)) else: if self.add_custom_from_service: self.create_from_service_item(item) @@ -288,7 +288,7 @@ class CustomMediaItem(MediaManagerItem): self.plugin.manager.save_object(custom) self.onSearchTextButtonClicked() if item.name.lower() == u'custom': - Receiver.send_message(u'service_item_update', u'%s:%s:%s' % (custom.id, item._uuid, False)) + Receiver.send_message(u'service_item_update', u'%s:%s:%s' % (custom.id, item.unique_identifyer, False)) def onClearTextButtonClick(self): """ diff --git a/openlp/plugins/remotes/lib/httpserver.py b/openlp/plugins/remotes/lib/httpserver.py index 7a0adc6d8..9b4707b6c 100644 --- a/openlp/plugins/remotes/lib/httpserver.py +++ b/openlp/plugins/remotes/lib/httpserver.py @@ -252,17 +252,17 @@ class HttpConnection(object): service_items = [] service_manager = self.parent.plugin.serviceManager if self.parent.current_item: - cur_uuid = self.parent.current_item._uuid + current_unique_identifyer = self.parent.current_item.unique_identifyer else: - cur_uuid = None + current_unique_identifyer = None for item in service_manager.serviceItems: service_item = item[u'service_item'] service_items.append({ - u'id': unicode(service_item._uuid), + u'id': unicode(service_item.unique_identifyer), u'title': unicode(service_item.get_display_title()), u'plugin': unicode(service_item.name), u'notes': unicode(service_item.notes), - u'selected': (service_item._uuid == cur_uuid) + u'selected': (service_item.unique_identifyer == current_unique_identifyer) }) return service_items @@ -386,9 +386,9 @@ class HttpConnection(object): Poll OpenLP to determine the current slide number and item name. """ result = { - u'service': self.parent.plugin.serviceManager.serviceId, + u'service': self.parent.plugin.serviceManager.service_id, u'slide': self.parent.current_slide or 0, - u'item': self.parent.current_item._uuid if self.parent.current_item else u'', + u'item': self.parent.current_item.unique_identifyer if self.parent.current_item else u'', u'twelve':Settings().value(u'remotes/twelve hour', True), u'blank': self.parent.plugin.liveController.blankScreen.isChecked(), u'theme': self.parent.plugin.liveController.themeScreen.isChecked(), @@ -459,7 +459,7 @@ class HttpConnection(object): data.append(item) json_data = {u'results': {u'slides': data}} if current_item: - json_data[u'results'][u'item'] = self.parent.current_item._uuid + json_data[u'results'][u'item'] = self.parent.current_item.unique_identifyer else: if self.url_params and self.url_params.get(u'data'): try: diff --git a/openlp/plugins/songs/lib/mediaitem.py b/openlp/plugins/songs/lib/mediaitem.py index 8351c2dd5..5759d720f 100644 --- a/openlp/plugins/songs/lib/mediaitem.py +++ b/openlp/plugins/songs/lib/mediaitem.py @@ -539,7 +539,7 @@ class SongMediaItem(MediaManagerItem): temporary = True # Update service with correct song id. if editId: - Receiver.send_message(u'service_item_update%s:%s:%s' % (editId, item._uuid, temporary)) + Receiver.send_message(u'service_item_update%s:%s:%s' % (editId, item.unique_identifyer, temporary)) def search(self, string, showError): """ diff --git a/tests/functional/openlp_core_lib/test_serviceitem.py b/tests/functional/openlp_core_lib/test_serviceitem.py index 3b288ad4a..39747994d 100644 --- a/tests/functional/openlp_core_lib/test_serviceitem.py +++ b/tests/functional/openlp_core_lib/test_serviceitem.py @@ -167,7 +167,6 @@ class TestServiceItem(TestCase): # THEN the service item should not be valid assert service_item.is_valid is False, u'The service item is not valid' - def serviceitem_load_custom_from_service_test(self): """ Test the Service Item - adding a custom slide from a saved service