vk-scripts 1.0.5__tar.gz → 1.1__tar.gz

{vk_scripts-1.0.5 → vk_scripts-1.1}/.github/workflows/ci.yml

@@ -18,9 +18,10 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     name: Linting
+    continue-on-error: "${{ github.ref != 'refs/heads/master' }}"
     steps:
       - name: Checkout
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
         with:
           fetch-depth: 0
       - name: Set up Python
@@ -40,7 +41,7 @@ jobs:
     name: 'Python ${{ matrix.python-version }}'
     steps:
       - name: Checkout
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
         with:
           fetch-depth: 0
       - name: Set up Python
@@ -63,7 +64,7 @@ jobs:
     name: Publish
     steps:
       - name: Checkout
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
         with:
           fetch-depth: 0
       - name: Set up Python

vk_scripts-1.1/.pylintrc

@@ -0,0 +1,8 @@
+[MESSAGES CONTROL]
+
+disable=
+    invalid-name,
+    missing-docstring,
+    multiple-imports,
+    too-few-public-methods,
+    too-many-public-methods,

{vk_scripts-1.0.5/vk_scripts.egg-info → vk_scripts-1.1}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: vk_scripts
-Version: 1.0.5
+Version: 1.1
 Summary: Scripts to stalk people on VK
 Author-email: Egor Tensin <egor@tensin.name>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/egor-tensin/vk-scripts
 Project-URL: Bug Tracker, https://github.com/egor-tensin/vk-scripts/issues
 Classifier: Development Status :: 5 - Production/Stable
-Requires-Python: >=3.4
+Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: importlib-metadata~=4.0; python_version < "3.8"
@@ -26,8 +26,6 @@ Installation
 
     pip install vk-scripts
 
-
-Python 3.4 or higher is required.
 `vk-sessions` uses [matplotlib].
 
 [matplotlib]: http://matplotlib.org/

{vk_scripts-1.0.5 → vk_scripts-1.1}/README.md

@@ -10,8 +10,6 @@ Installation
 
     pip install vk-scripts
 
-
-Python 3.4 or higher is required.
 `vk-sessions` uses [matplotlib].
 
 [matplotlib]: http://matplotlib.org/

{vk_scripts-1.0.5 → vk_scripts-1.1}/docs/mutuals.md

@@ -13,8 +13,8 @@ Usage
 For example (using made up user IDs/"screen names"),
 
     > vk-mutuals john.doe jane.doe
-    89497105,John,Smith
-    3698577,Jane,Smith
+    89497105,John,Smith,john.smith
+    3698577,Jane,Smith,jane.smith
 
 In the example above, both "John Doe" and "Jane Doe" are friends with "John
 Smith" and "Jane Smith", whose user IDs are 89497105 and 3698577 respectively.
@@ -27,18 +27,13 @@ You can also get a JSON document:
        {
           "uid": 89497105,
           "first_name": "John",
-          "last_name": "Smith"
+          "last_name": "Smith",
+          "domain": "john.smith"
        },
        {
           "uid": 3698577,
           "first_name": "Jane",
-          "last_name": "Smith"
+          "last_name": "Smith",
+          "domain": "jane.smith"
        }
     ]
-
-See also
---------
-
-* [License]
-
-[License]: ../README.md#license

{vk_scripts-1.0.5 → vk_scripts-1.1}/docs/sessions.md

@@ -159,10 +159,3 @@ Known issues
 time (for example, just listening to music), they appear offline.
 Hence the 0:00:00 durations you might sometimes encounter.
 This might also happen using other clients.
-
-See also
---------
-
-* [License]
-
-[License]: ../README.md#license

{vk_scripts-1.0.5 → vk_scripts-1.1}/docs/status.md

@@ -31,10 +31,3 @@ If you want to record when people go online/offline for further analysis using
 [vk-sessions], specify the path to a database using the `--output` parameter.
 
 [vk-sessions]: sessions.md
-
-See also
---------
-
-* [License]
-
-[License]: ../README.md#license

{vk_scripts-1.0.5 → vk_scripts-1.1}/pyproject.toml

@@ -12,7 +12,7 @@ license-files = ["LICENSE.txt"]
 dynamic = ["version"]
 authors = [{name = "Egor Tensin", email = "egor@tensin.name"}]
 readme = "README.md"
-requires-python = ">=3.4"
+requires-python = ">=3.6"
 
 dependencies = [
     'importlib-metadata ~= 4.0 ; python_version < "3.8"',
@@ -33,6 +33,3 @@ vk-status = "vk.tracking.status:main"
 vk-mutuals = "vk.mutuals:main"
 
 [tool.setuptools_scm]
-
-[tool.black]
-skip-string-normalization = true

{vk_scripts-1.0.5 → vk_scripts-1.1}/vk/api.py

@@ -49,29 +49,29 @@ def _build_url(scheme, host, path, params=None, empty_params=False):
     else:
         raise TypeError()
     path = urllib.parse.quote(path)
-    return urllib.parse.urlunsplit((scheme, host, path, params, ''))
+    return urllib.parse.urlunsplit((scheme, host, path, params, ""))
 
 
 def _join_param_values(values):
     if isinstance(values, str):
         return values
     if isinstance(values, Iterable):
-        return ','.join(map(str, values))
+        return ",".join(map(str, values))
     return values
 
 
 def _join_path(base, url):
-    if not base.endswith('/'):
-        base += '/'
+    if not base.endswith("/"):
+        base += "/"
     return urllib.parse.urljoin(base, url)
 
 
-ACCESS_TOKEN = '9722cef09722cef09722cef071974b8cbe997229722cef0cbabfd816916af6c7bd37006'
+ACCESS_TOKEN = "9722cef09722cef09722cef071974b8cbe997229722cef0cbabfd816916af6c7bd37006"
 
 
 class Version(Enum):
     # https://dev.vk.com/en/reference/versions
-    V5_199 = '5.199'
+    V5_199 = "5.199"
     DEFAULT = V5_199
 
     def __str__(self):
@@ -79,7 +79,7 @@ class Version(Enum):
 
 
 class Language(Enum):
-    EN = 'en'
+    EN = "en"
     DEFAULT = EN
 
     def __str__(self):
@@ -87,24 +87,24 @@ class Language(Enum):
 
 
 class Method(Enum):
-    USERS_GET = 'users.get'
-    FRIENDS_GET = 'friends.get'
+    USERS_GET = "users.get"
+    FRIENDS_GET = "friends.get"
 
     def __str__(self):
         return self.value
 
 
 class CommonParameters(Enum):
-    ACCESS_TOKEN = 'access_token'
-    VERSION = 'v'
-    LANGUAGE = 'lang'
+    ACCESS_TOKEN = "access_token"
+    VERSION = "v"
+    LANGUAGE = "lang"
 
     def __str__(self):
         return self.value
 
 
 class API:
-    _ROOT_URL = 'https://api.vk.com/method/'
+    _ROOT_URL = "https://api.vk.com/method/"
 
     _SCHEME, _HOST, _ROOT_PATH = _split_url(_ROOT_URL)
 
@@ -127,9 +127,9 @@ class API:
             with urlopen(url) as response:
                 response = json.loads(response.read().decode())
                 # print(response)
-                if 'response' not in response:
+                if "response" not in response:
                     raise vk.error.InvalidAPIResponseError(response)
-                return response['response']
+                return response["response"]
         except (ConnectionError, URLError) as e:
             raise vk.error.APIConnectionError(str(e)) from e
 
@@ -138,7 +138,7 @@ class API:
         user_list = map(User.from_api_response, user_list)
         if deactivated_users:
             return user_list
-        return [user for user in user_list if not user.is_deactivated()]
+        return [user for user in user_list if not user.is_deactivated]
 
     def users_get(self, user_ids, fields=(), deactivated_users=True):
         return self._filter_response_with_users(
@@ -154,6 +154,6 @@ class API:
         response = self._call_method(
             Method.FRIENDS_GET, user_id=user_id, fields=_join_param_values(fields)
         )
-        if 'items' not in response:
+        if "items" not in response:
             raise vk.error.InvalidAPIResponseError(response)
-        return self._filter_response_with_users(response['items'], deactivated_users)
+        return self._filter_response_with_users(response["items"], deactivated_users)

{vk_scripts-1.0.5 → vk_scripts-1.1}/vk/last_seen.py

@@ -31,8 +31,8 @@ def _parse_platform(x):
 
 
 class LastSeenField(Enum):
-    TIME = 'time'
-    PLATFORM = 'platform'
+    TIME = "time"
+    PLATFORM = "platform"
 
     def __str__(self):
         return self.value
@@ -80,20 +80,14 @@ class LastSeen(MutableMapping):
 
     _DEFAULT_FIELD_PARSER = str
 
-    def has_time(self):
-        return LastSeenField.TIME in self
-
-    def get_time(self):
+    @property
+    def time(self):
         return self[LastSeenField.TIME]
 
-    def set_time(self, time):
-        self[LastSeenField.TIME] = time
-
-    def has_platform(self):
-        return LastSeenField.PLATFORM in self
+    @property
+    def time_local(self):
+        return self.time.astimezone()
 
-    def get_platform(self):
+    @property
+    def platform(self):
         return self[LastSeenField.PLATFORM]
-
-    def set_platform(self, platform):
-        self[LastSeenField.PLATFORM] = platform

{vk_scripts-1.0.5 → vk_scripts-1.1}/vk/mutuals.py

@@ -14,11 +14,16 @@ from vk.user import UserField
 from vk.utils import io
 import vk.version
 
-_OUTPUT_USER_FIELDS = UserField.UID, UserField.FIRST_NAME, UserField.LAST_NAME
+_OUTPUT_USER_FIELDS = (
+    UserField.UID,
+    UserField.FIRST_NAME,
+    UserField.LAST_NAME,
+    UserField.DOMAIN,
+)
 
 
 def _query_friend_list(api, user):
-    return api.friends_get(user.get_uid(), fields=_OUTPUT_USER_FIELDS)
+    return api.friends_get(user.uid, fields=_OUTPUT_USER_FIELDS)
 
 
 def _filter_user_fields(user):
@@ -52,8 +57,8 @@ class OutputSinkJSON(OutputSinkMutualFriends):
 
 
 class OutputFormat(Enum):
-    CSV = 'csv'
-    JSON = 'json'
+    CSV = "csv"
+    JSON = "json"
 
     def __str__(self):
         return self.value
@@ -67,14 +72,14 @@ class OutputFormat(Enum):
             return OutputSinkCSV(fd)
         if self is OutputFormat.JSON:
             return OutputSinkJSON(fd)
-        raise NotImplementedError('unsupported output format: ' + str(self))
+        raise NotImplementedError(f"unsupported output format: {self}")
 
 
 def _parse_output_format(s):
     try:
         return OutputFormat(s)
     except ValueError:
-        raise argparse.ArgumentTypeError('invalid output format: ' + s)
+        raise argparse.ArgumentTypeError(f"invalid output format: {s}")
 
 
 def _parse_args(args=None):
@@ -82,29 +87,29 @@ def _parse_args(args=None):
         args = sys.argv[1:]
 
     parser = argparse.ArgumentParser(
-        description='Learn who your ex and her new boyfriend are both friends with.'
+        description="Learn who your ex and her new boyfriend are both friends with."
     )
 
     vk.version.add_to_arg_parser(parser)
 
     parser.add_argument(
-        'uids', metavar='UID', nargs='+', help='user IDs or "screen names"'
+        "uids", metavar="UID", nargs="+", help='user IDs or "screen names"'
     )
     parser.add_argument(
-        '-f',
-        '--format',
-        dest='out_fmt',
+        "-f",
+        "--format",
+        dest="out_fmt",
         type=_parse_output_format,
         default=OutputFormat.CSV,
         choices=OutputFormat,
-        help='specify output format',
+        help="specify output format",
     )
     parser.add_argument(
-        '-o',
-        '--output',
-        metavar='PATH',
-        dest='out_path',
-        help='set output file path (standard output by default)',
+        "-o",
+        "--output",
+        metavar="PATH",
+        dest="out_path",
+        help="set output file path (standard output by default)",
     )
 
     return parser.parse_args(args)
@@ -127,5 +132,5 @@ def main(args=None):
     write_mutual_friends(**vars(_parse_args(args)))
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

vk_scripts-1.1/vk/platform.py

@@ -0,0 +1,39 @@
+# Copyright (c) 2016 Egor Tensin <egor@tensin.name>
+# This file is part of the "VK scripts" project.
+# For details, see https://github.com/egor-tensin/vk-scripts.
+# Distributed under the MIT License.
+
+from enum import Enum
+
+
+class Platform(Enum):
+    # https://dev.vk.com/en/reference/objects/user#last_seen
+    MOBILE = 1
+    IPHONE = 2
+    IPAD = 3
+    ANDROID = 4
+    WINDOWS_PHONE = 5
+    WINDOWS10 = 6
+    WEB = 7
+
+    @staticmethod
+    def from_string(s):
+        return Platform(int(s))
+
+    def __str__(self):
+        return str(self.value)
+
+    @property
+    def descr(self):
+        return f"the {_PLATFORM_DESCRIPTIONS[self]}"
+
+
+_PLATFORM_DESCRIPTIONS = {
+    Platform.MOBILE: '"mobile" web version (or an unrecognized mobile app)',
+    Platform.IPHONE: "official iPhone app",
+    Platform.IPAD: "official iPad app",
+    Platform.ANDROID: "official Android app",
+    Platform.WINDOWS_PHONE: "official Windows Phone app",
+    Platform.WINDOWS10: "official Windows 10 app",
+    Platform.WEB: "web version (or an unrecognized app)",
+}

{vk_scripts-1.0.5 → vk_scripts-1.1}/vk/tracking/__init__.py

@@ -3,6 +3,6 @@
 # See LICENSE.txt for details.
 
 __all__ = (
-    'sessions',
-    'status',
+    "sessions",
+    "status",
 )

{vk_scripts-1.0.5 → vk_scripts-1.1}/vk/tracking/db/__init__.py

@@ -5,4 +5,4 @@
 
 from .format import Format
 
-__all__ = 'format'
+__all__ = ("format",)

{vk_scripts-1.0.5 → vk_scripts-1.1}/vk/tracking/db/backend/__init__.py

@@ -6,7 +6,7 @@
 from . import csv, log, null
 
 __all__ = (
-    'csv',
-    'log',
-    'null',
+    "csv",
+    "log",
+    "null",
 )

{vk_scripts-1.0.5 → vk_scripts-1.1}/vk/tracking/db/backend/csv.py

@@ -43,6 +43,6 @@ class Reader(meta.Reader):
     @staticmethod
     def _record_from_row(row):
         record = Record(Timestamp.from_string(row[0]))
-        for i in range(len(Record.FIELDS)):
-            record[Record.FIELDS[i]] = row[i + 1]
+        for i, field in enumerate(Record.FIELDS):
+            record[field] = row[i + 1]
         return record

{vk_scripts-1.0.5 → vk_scripts-1.1}/vk/tracking/db/backend/log.py

@@ -15,7 +15,7 @@ class Writer(meta.Writer):
         handler = logging.StreamHandler(fd)
         handler.setFormatter(
             logging.Formatter(
-                fmt='[%(asctime)s] %(message)s', datefmt='%Y-%m-%d %H:%M:%S%z'
+                fmt="[%(asctime)s] %(message)s", datefmt="%Y-%m-%d %H:%M:%S%z"
             )
         )
         self._logger.addHandler(handler)
@@ -47,7 +47,7 @@ class Writer(meta.Writer):
 
     def on_initial_status(self, user):
         self._reset_last_notification()
-        if user.is_online():
+        if user.is_online:
             self.info(self._format_user_is_online(user))
         else:
             self.info(self._format_user_is_offline(user))
@@ -55,7 +55,7 @@ class Writer(meta.Writer):
 
     def on_status_update(self, user):
         self._reset_last_notification()
-        if user.is_online():
+        if user.is_online:
             self.info(self._format_user_went_online(user))
         else:
             self.info(self._format_user_went_offline(user))
@@ -69,39 +69,26 @@ class Writer(meta.Writer):
         self._set_last_notification(e)
         self.exception(e)
 
-    @staticmethod
-    def _format_user(user):
-        if user.has_last_name():
-            return '{} {}'.format(user.get_first_name(), user.get_last_name())
-        return '{}'.format(user.get_first_name())
-
     @staticmethod
     def _format_user_is_online(user):
-        return '{} is ONLINE.'.format(Writer._format_user(user))
+        return f"{user.full_name} is ONLINE."
 
     @staticmethod
     def _format_user_is_offline(user):
-        return '{} is OFFLINE.'.format(Writer._format_user(user))
+        return f"{user.full_name} is OFFLINE."
 
     @staticmethod
     def _format_user_last_seen(user):
-        return '{} was last seen at {} using {}.'.format(
-            Writer._format_user(user),
-            user.get_last_seen_time_local(),
-            user.get_last_seen_platform().get_descr_text(),
-        )
+        return f"{user.full_name} was last seen at {user.last_seen.time_local} using {user.last_seen.platform.descr}."
 
     @staticmethod
     def _format_user_went_online(user):
-        return '{} went ONLINE.'.format(Writer._format_user(user))
+        return f"{user.full_name} went ONLINE."
 
     @staticmethod
     def _format_user_went_offline(user):
-        return '{} went OFFLINE.'.format(Writer._format_user(user))
+        return f"{user.full_name} went OFFLINE."
 
     @staticmethod
     def _format_another_connection_error(e):
-        return (
-            'Encountered a connection error which looks like the previous one: '
-            + str(e)
-        )
+        return f"Encountered a connection error which looks like the previous one: {e}"

{vk_scripts-1.0.5 → vk_scripts-1.1}/vk/tracking/db/format.py

@@ -12,9 +12,9 @@ from . import backend
 
 
 class Format(Enum):
-    CSV = 'csv'
-    LOG = 'log'
-    NULL = 'null'
+    CSV = "csv"
+    LOG = "log"
+    NULL = "null"
 
     def __str__(self):
         return self.value
@@ -26,7 +26,7 @@ class Format(Enum):
             return backend.log.Writer(fd)
         if self is Format.NULL:
             return backend.null.Writer()
-        raise NotImplementedError('unsupported database format: ' + str(self))
+        raise NotImplementedError(f"unsupported database format: {self}")
 
     def open_output_file(self, path=None):
         if self is Format.CSV:
@@ -35,30 +35,30 @@ class Format(Enum):
             return self._open_output_log_file(path)
         if self is Format.NULL:
             return self._open_output_database_file(None)
-        raise NotImplementedError('unsupported database format: ' + str(self))
+        raise NotImplementedError(f"unsupported database format: {self}")
 
     @staticmethod
     def _open_output_log_file(path):
-        return io.open_output_text_file(path, mode='a')
+        return io.open_output_text_file(path, mode="a")
 
     @staticmethod
     def _open_output_database_file(path):
-        return io.open_output_text_file(path, mode='x')
+        return io.open_output_text_file(path, mode="x")
 
     def create_reader(self, fd=sys.stdin):
         if self is Format.CSV:
             return backend.csv.Reader(fd)
         if self is Format.LOG:
-            return NotImplementedError('cannot read from a log file')
+            return NotImplementedError("cannot read from a log file")
         if self is Format.NULL:
             return backend.null.Reader()
-        raise NotImplementedError('unsupported database format: ' + str(self))
+        raise NotImplementedError(f"unsupported database format: {self}")
 
     def open_input_file(self, path=None):
         if self is Format.CSV:
             return io.open_input_text_file(path)
         if self is Format.LOG:
-            raise NotImplementedError('cannot read from a log file')
+            raise NotImplementedError("cannot read from a log file")
         if self is Format.NULL:
             return io.open_input_text_file(None)
-        raise NotImplementedError('unsupported database format: ' + str(self))
+        raise NotImplementedError(f"unsupported database format: {self}")

{vk_scripts-1.0.5 → vk_scripts-1.1}/vk/tracking/db/record.py

@@ -73,7 +73,7 @@ class Record(MutableMapping):
             if isinstance(field, UserField):
                 record[field] = user[field]
             elif isinstance(field, LastSeenField):
-                record[field] = user.get_last_seen()[field]
+                record[field] = user.last_seen[field]
             else:
                 assert False
         return record
@@ -98,5 +98,5 @@ class Record(MutableMapping):
             else:
                 assert False
         if last_seen:
-            user.set_last_seen(last_seen)
+            user.last_seen = last_seen
         return user

{vk_scripts-1.0.5 → vk_scripts-1.1}/vk/tracking/db/timestamp.py

@@ -30,7 +30,7 @@ class Timestamp:
 
     @staticmethod
     def from_string(s):
-        return Timestamp(datetime.strptime(s, '%Y-%m-%dT%H:%M:%SZ'))
+        return Timestamp(datetime.strptime(s, "%Y-%m-%dT%H:%M:%SZ"))
 
     def __str__(self):
-        return self.dt.isoformat() + 'Z'
+        return f"{self.dt.isoformat()}Z"