This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2999

infinitepush: use zope.interface to define indexapi interface
Needs RevisionPublic

Authored by pulkit on Mar 31 2018, 7:54 AM.

Details

Reviewers
indygreg
Group Reviewers
hg-reviewers
Summary

This patch makes indexapi use zope.interface which is now vendored with
mercurial.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

pulkit created this revision.Mar 31 2018, 7:54 AM
indygreg requested changes to this revision.Mar 31 2018, 1:22 PM
indygreg added a subscriber: indygreg.

Please also add test coverage to test-check-interfaces.py, otherwise these interfaces mean practically nothing. zope.interface doesn't perform run-time interface conformance tests unless you explicitly instruct it to. For now, we're going to verify interfaces in test-check-interfaces.py.

hgext/infinitepush/indexapi.py
25

Interface classes don't define self on methods. So please drop self from all these methods.

This revision now requires changes to proceed.Mar 31 2018, 1:22 PM
indygreg added a comment.Mar 31 2018, 1:24 PM

Oh, when you add test coverage, watch out for mysql.connector being unavailable. You may want to register a fake module in sys.modules['mysql.connector'] to ensure it always is available.

Revision Contents
Changeset List

Diff 7466

hgext/infinitepush/fileindexapi.py

# Filesystem path to the index store # Filesystem path to the index store
indexpath = PATH indexpath = PATH
""" """
from __future__ import absolute_import from __future__ import absolute_import
import os import os
from mercurial.thirdparty.zope import (
interface as zi,
)
from mercurial.utils import stringutil from mercurial.utils import stringutil
from . import indexapi from . import indexapi
class fileindexapi(indexapi.indexapi): @zi.implementer(indexapi.indexapi)
class fileindexapi(object):
def __init__(self, repo): def __init__(self, repo):
super(fileindexapi, self).__init__() super(fileindexapi, self).__init__()
self._repo = repo self._repo = repo
root = repo.ui.config('infinitepush', 'indexpath') root = repo.ui.config('infinitepush', 'indexpath')
if not root: if not root:
root = os.path.join('scratchbranches', 'index') root = os.path.join('scratchbranches', 'index')
self._nodemap = os.path.join(root, 'nodemap') self._nodemap = os.path.join(root, 'nodemap')

hgext/infinitepush/indexapi.py

# Infinite push # Infinite push
# #
# Copyright 2016 Facebook, Inc. # Copyright 2016 Facebook, Inc.
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
class indexapi(object): from mercurial.thirdparty.zope import (
interface as zi,
)
class indexapi(zi.Interface):
"""Class that manages access to infinitepush index. """Class that manages access to infinitepush index.
This class is a context manager and all write operations (like This class is a context manager and all write operations (like
deletebookmarks, addbookmark etc) should use `with` statement: deletebookmarks, addbookmark etc) should use `with` statement:
with index: with index:
index.deletebookmarks(...) index.deletebookmarks(...)
... ...
""" """
def __init__(self): def __init__(self):
indygregUnsubmitted
Not Done

Interface classes don't define self on methods. So please drop self from all these methods.

indygreg: `Interface` classes don't define `self` on methods. So please drop `self` from all these…
"""Initializes the metadata store connection.""" """Initializes the metadata store connection."""
def close(self): def close(self):
"""Cleans up the metadata store connection.""" """Cleans up the metadata store connection."""
def __enter__(self): def __enter__(self):
return self return self

hgext/infinitepush/sqlindexapi.py

# Infinite push # Infinite push
# #
# Copyright 2016 Facebook, Inc. # Copyright 2016 Facebook, Inc.
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
import logging import logging
import os import os
import time import time
import warnings import warnings
import mysql.connector import mysql.connector
from mercurial.thirdparty.zope import (
interface as zi,
)
from . import indexapi from . import indexapi
def _convertbookmarkpattern(pattern): def _convertbookmarkpattern(pattern):
pattern = pattern.replace('_', '\\_') pattern = pattern.replace('_', '\\_')
pattern = pattern.replace('%', '\\%') pattern = pattern.replace('%', '\\%')
if pattern.endswith('*'): if pattern.endswith('*'):
pattern = pattern[:-1] + '%' pattern = pattern[:-1] + '%'
return pattern return pattern
class sqlindexapi(indexapi.indexapi): @zi.implementer(indexapi.indexapi)
class sqlindexapi(object):
''' '''
Sql backend for infinitepush index. See schema.sql Sql backend for infinitepush index. See schema.sql
''' '''
def __init__(self, reponame, host, port, def __init__(self, reponame, host, port,
database, user, password, logfile, loglevel, database, user, password, logfile, loglevel,
waittimeout=300, locktimeout=120): waittimeout=300, locktimeout=120):
super(sqlindexapi, self).__init__() super(sqlindexapi, self).__init__()