From 3f69a2c24093c87bedcf79797b46428aafb5e4a3 Mon Sep 17 00:00:00 2001 From: Ethan Dalool Date: Sat, 11 Nov 2017 22:38:51 -0800 Subject: [PATCH] Cleanup: Replace "objectid" with "object_id" in the Python portions. --- etiquette/photodb.py | 16 +-- etiquette/searchhelpers.py | 4 +- .../etiquette_flask/etiquette_flask.py | 110 +++++++++--------- frontends/etiquette_repl.py | 4 +- 4 files changed, 67 insertions(+), 67 deletions(-) diff --git a/etiquette/photodb.py b/etiquette/photodb.py index 0008992..d97b9fb 100644 --- a/etiquette/photodb.py +++ b/etiquette/photodb.py @@ -229,7 +229,7 @@ class PDBAlbumMixin: ''' Create a new album. Photos can be added now or later. ''' - albumid = self.generate_id('albums') + album_id = self.generate_id('albums') title = title or '' description = description or '' if not isinstance(title, str): @@ -242,7 +242,7 @@ class PDBAlbumMixin: self.log.debug('New Album: %s' % title) data = { - 'id': albumid, + 'id': album_id, 'title': title, 'description': description, } @@ -319,8 +319,8 @@ class PDBPhotoMixin: super().__init__() self._photo_cache = cacheclass.Cache() - def get_photo(self, photoid): - return self.get_thing_by_id('photo', photoid) + def get_photo(self, id): + return self.get_thing_by_id('photo', id) def get_photo_by_path(self, filepath): filepath = pathclass.Path(filepath) @@ -394,10 +394,10 @@ class PDBPhotoMixin: author_id = self.get_user_id_or_none(author) created = int(helpers.now()) - photoid = self.generate_id('photos') + photo_id = self.generate_id('photos') data = { - 'id': photoid, + 'id': photo_id, 'filepath': filepath.absolute_path, 'override_filename': None, 'extension': filepath.extension, @@ -710,7 +710,7 @@ class PDBPhotoMixin: yield parameters if is_must_may_forbid: - mmf_results = searchhelpers.mmf_photoids( + mmf_results = searchhelpers.mmf_photo_ids( self, tag_musts, tag_mays, @@ -721,7 +721,7 @@ class PDBPhotoMixin: else: mmf_results = None - if mmf_results is not None and mmf_results['photoids'] == set(): + if mmf_results is not None and mmf_results['photo_ids'] == set(): generator = [] else: query = searchhelpers.build_query( diff --git a/etiquette/searchhelpers.py b/etiquette/searchhelpers.py index 93edcd2..4509582 100644 --- a/etiquette/searchhelpers.py +++ b/etiquette/searchhelpers.py @@ -120,7 +120,7 @@ def minmax(key, value, minimums, maximums, warning_bag=None): if high is not None: maximums[key] = high -def mmf_photoids(photodb, tag_musts, tag_mays, tag_forbids, frozen_children): +def mmf_photo_ids(photodb, tag_musts, tag_mays, tag_forbids, frozen_children): if not(tag_musts or tag_mays or tag_forbids): return None @@ -170,7 +170,7 @@ def mmf_photoids(photodb, tag_musts, tag_mays, tag_forbids, frozen_children): else: results.update(photo_ids) - return {'operator': operator, 'photoids': results} + return {'operator': operator, 'photo_ids': results} def normalize_authors(authors, photodb, warning_bag=None): ''' diff --git a/frontends/etiquette_flask/etiquette_flask/etiquette_flask.py b/frontends/etiquette_flask/etiquette_flask/etiquette_flask.py index 5a8868e..6a94ab5 100644 --- a/frontends/etiquette_flask/etiquette_flask/etiquette_flask.py +++ b/frontends/etiquette_flask/etiquette_flask/etiquette_flask.py @@ -103,16 +103,16 @@ def P_wrapper(function): return P_wrapped @P_wrapper -def P_album(albumid): - return P.get_album(albumid) +def P_album(album_id): + return P.get_album(album_id) @P_wrapper def P_bookmark(bookmarkid): return P.get_bookmark(bookmarkid) @P_wrapper -def P_photo(photoid): - return P.get_photo(photoid) +def P_photo(photo_id): + return P.get_photo(photo_id) @P_wrapper def P_tag(tagname): @@ -123,8 +123,8 @@ def P_user(username): return P.get_user(username=username) @P_wrapper -def P_user_id(userid): - return P.get_user(id=userid) +def P_user_id(user_id): + return P.get_user(id=user_id) def send_file(filepath, override_mimetype=None): ''' @@ -206,8 +206,8 @@ def send_file(filepath, override_mimetype=None): #################################################################################################### -def get_album_core(albumid): - album = P_album(albumid) +def get_album_core(album_id): + album = P_album(album_id) return album def get_albums_core(): @@ -355,8 +355,8 @@ def get_tags_core(specific_tag=None): tags.sort(key=lambda x: x.qualified_name()) return tags -def post_photo_add_remove_tag_core(photoid, tagname, add_or_remove): - photo = P_photo(photoid, response_type='json') +def post_photo_add_remove_tag_core(photo_id, tagname, add_or_remove): + photo = P_photo(photo_id, response_type='json') tag = P_tag(tagname, response_type='json') try: @@ -397,10 +397,10 @@ def root(): session = session_manager.get(request) return flask.render_template('root.html', motd=motd, session=session) -@site.route('/album/') +@site.route('/album/') @session_manager.give_token -def get_album_html(albumid): - album = get_album_core(albumid) +def get_album_html(album_id): + album = get_album_core(album_id) session = session_manager.get(request) response = flask.render_template( 'album.html', @@ -410,19 +410,19 @@ def get_album_html(albumid): ) return response -@site.route('/album/.json') +@site.route('/album/.json') @session_manager.give_token -def get_album_json(albumid): - album = get_album_core(albumid) +def get_album_json(album_id): + album = get_album_core(album_id) album = etiquette.jsonify.album(album) album['sub_albums'] = [P_album(x) for x in album['sub_albums']] album['sub_albums'].sort(key=lambda x: (x.title or x.id).lower()) album['sub_albums'] = [etiquette.jsonify.album(x, minimal=True) for x in album['sub_albums']] return jsonify.make_json_response(album) -@site.route('/album/.zip') -def get_album_zip(albumid): - album = P_album(albumid) +@site.route('/album/.zip') +def get_album_zip(album_id): + album = P_album(album_id) recursive = request.args.get('recursive', True) recursive = etiquette.helpers.truthystring(recursive) @@ -463,14 +463,14 @@ def get_album_zip(albumid): } return flask.Response(streamed_zip, headers=outgoing_headers) -@site.route('/album//add_tag', methods=['POST']) +@site.route('/album//add_tag', methods=['POST']) @session_manager.give_token -def post_album_add_tag(albumid): +def post_album_add_tag(album_id): ''' Apply a tag to every photo in the album. ''' response = {} - album = P_album(albumid) + album = P_album(album_id) tag = request.form['tagname'].strip() try: @@ -485,13 +485,13 @@ def post_album_add_tag(albumid): response['tagname'] = tag.name return jsonify.make_json_response(response) -@site.route('/album//edit', methods=['POST']) +@site.route('/album//edit', methods=['POST']) @session_manager.give_token -def post_album_edit(albumid): +def post_album_edit(album_id): ''' Edit the title / description. ''' - album = P_album(albumid) + album = P_album(album_id) title = request.form.get('title', None) description = request.form.get('description', None) @@ -594,10 +594,10 @@ def favicon(): return flask.send_file(FAVICON_PATH.absolute_path) -@site.route('/file/') -def get_file(photoid): - photoid = photoid.split('.')[0] - photo = P.get_photo(photoid) +@site.route('/file/') +def get_file(photo_id): + photo_id = photo_id.split('.')[0] + photo = P.get_photo(photo_id) do_download = request.args.get('download', False) do_download = etiquette.helpers.truthystring(do_download) @@ -663,36 +663,36 @@ def logout(): return response -@site.route('/photo/', methods=['GET']) +@site.route('/photo/', methods=['GET']) @session_manager.give_token -def get_photo_html(photoid): - photo = P_photo(photoid, response_type='html') +def get_photo_html(photo_id): + photo = P_photo(photo_id, response_type='html') session = session_manager.get(request) return flask.render_template('photo.html', photo=photo, session=session) -@site.route('/photo/.json', methods=['GET']) +@site.route('/photo/.json', methods=['GET']) @session_manager.give_token -def get_photo_json(photoid): - photo = P_photo(photoid, response_type='json') +def get_photo_json(photo_id): + photo = P_photo(photo_id, response_type='json') photo = etiquette.jsonify.photo(photo) photo = jsonify.make_json_response(photo) return photo -@site.route('/photo//add_tag', methods=['POST']) +@site.route('/photo//add_tag', methods=['POST']) @decorators.required_fields(['tagname'], forbid_whitespace=True) -def post_photo_add_tag(photoid): +def post_photo_add_tag(photo_id): ''' Add a tag to this photo. ''' - return post_photo_add_remove_tag_core(photoid, request.form['tagname'], 'add') + return post_photo_add_remove_tag_core(photo_id, request.form['tagname'], 'add') -@site.route('/photo//refresh_metadata', methods=['POST']) -def post_photo_refresh_metadata(photoid): +@site.route('/photo//refresh_metadata', methods=['POST']) +def post_photo_refresh_metadata(photo_id): ''' Refresh the file metadata. ''' - P.caches['photo'].remove(photoid) - photo = P_photo(photoid, response_type='json') + P.caches['photo'].remove(photo_id) + photo = P_photo(photo_id, response_type='json') try: photo.reload_metadata() except etiquette.exceptions.EtiquetteException as e: @@ -707,13 +707,13 @@ def post_photo_refresh_metadata(photoid): return jsonify.make_json_response({}) -@site.route('/photo//remove_tag', methods=['POST']) +@site.route('/photo//remove_tag', methods=['POST']) @decorators.required_fields(['tagname'], forbid_whitespace=True) -def post_photo_remove_tag(photoid): +def post_photo_remove_tag(photo_id): ''' Remove a tag from this photo. ''' - return post_photo_add_remove_tag_core(photoid, request.form['tagname'], 'remove') + return post_photo_add_remove_tag_core(photo_id, request.form['tagname'], 'remove') @site.route('/register', methods=['GET']) @@ -876,10 +876,10 @@ def post_tag_delete(): return post_tag_create_delete_core(request.form['tagname'], delete_tag) -@site.route('/thumbnail/') -def get_thumbnail(photoid): - photoid = photoid.split('.')[0] - photo = P_photo(photoid) +@site.route('/thumbnail/') +def get_thumbnail(photo_id): + photo_id = photo_id.split('.')[0] + photo = P_photo(photo_id) if photo.thumbnail: path = photo.thumbnail else: @@ -901,14 +901,14 @@ def get_user_json(username): user = etiquette.jsonify.user(user) return jsonify.make_json_response(user) -@site.route('/userid/') -@site.route('/userid/.json') -def get_user_id_redirect(userid): +@site.route('/userid/') +@site.route('/userid/.json') +def get_user_id_redirect(user_id): if request.url.endswith('.json'): - user = P_user_id(userid, response_type='json') + user = P_user_id(user_id, response_type='json') else: - user = P_user_id(userid, response_type='html') - url_from = '/userid/' + userid + user = P_user_id(user_id, response_type='html') + url_from = '/userid/' + user_id url_to = '/user/' + user.username url = request.url.replace(url_from, url_to) return flask.redirect(url) diff --git a/frontends/etiquette_repl.py b/frontends/etiquette_repl.py index b76c00d..ee60810 100644 --- a/frontends/etiquette_repl.py +++ b/frontends/etiquette_repl.py @@ -22,8 +22,8 @@ def easytagger(): else: P.easybake(i) -def photag(photoid): - photo = P.get_photo_by_id(photoid) +def photag(photo_id): + photo = P.get_photo_by_id(photo_id) print(photo.tags()) while True: photo.add_tag(input('> '))