File: Traffic.py

package info (click to toggle)
pygithub 2.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 33,476 kB
  • sloc: python: 38,409; sh: 7; makefile: 6
file content (100 lines) | stat: -rw-r--r-- 4,776 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
############################ Copyrights and license ############################
#                                                                              #
# Copyright 2018 Justin Kufro <jkufro@andrew.cmu.edu>                          #
# Copyright 2019 Steve Kowalik <steven@wedontsleep.org>                        #
# Copyright 2019 TechnicalPirate <35609336+TechnicalPirate@users.noreply.github.com>#
# Copyright 2019 Wan Liuyang <tsfdye@gmail.com>                                #
# Copyright 2020 Steve Kowalik <steven@wedontsleep.org>                        #
# Copyright 2023 Enrico Minack <github@enrico.minack.dev>                      #
# Copyright 2025 Enrico Minack <github@enrico.minack.dev>                      #
#                                                                              #
# This file is part of PyGithub.                                               #
# http://pygithub.readthedocs.io/                                              #
#                                                                              #
# PyGithub is free software: you can redistribute it and/or modify it under    #
# the terms of the GNU Lesser General Public License as published by the Free  #
# Software Foundation, either version 3 of the License, or (at your option)    #
# any later version.                                                           #
#                                                                              #
# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY  #
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS    #
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
# details.                                                                     #
#                                                                              #
# You should have received a copy of the GNU Lesser General Public License     #
# along with PyGithub. If not, see <http://www.gnu.org/licenses/>.             #
#                                                                              #
################################################################################

from __future__ import annotations

from datetime import datetime, timezone

from . import Framework


class Traffic(Framework.TestCase):
    def setUp(self):
        super().setUp()
        self.user = self.g.get_user()
        self.repo = self.user.get_repo("PyGithub")

    def testGetReferrers(self):
        referrerResponse = self.repo.get_top_referrers()
        self.assertGreaterEqual(len(referrerResponse), 1)
        self.assertEqual(referrerResponse[0].uniques, 1)
        self.assertEqual(referrerResponse[0].referrer, "github.com")
        self.assertEqual(referrerResponse[0].count, 5)
        self.assertEqual(
            repr(referrerResponse[0]),
            'Referrer(uniques=1, referrer="github.com", count=5)',
        )

    def testGetPaths(self):
        pathsResponse = self.repo.get_top_paths()
        self.assertEqual(len(pathsResponse), 10)
        self.assertEqual(pathsResponse[0].uniques, 4)
        self.assertEqual(pathsResponse[0].count, 23)
        self.assertEqual(pathsResponse[0].path, "/jkufro/PyGithub")
        self.assertEqual(
            pathsResponse[0].title,
            "jkufro/PyGithub: Typed interactions with the GitHub API v3",
        )
        self.assertEqual(
            repr(pathsResponse[0]),
            'Path(uniques=4, title="jkufro/PyGithub: Typed interactions with the GitHub API v3", path="/jkufro/PyGithub", count=23)',
        )

    def testGetViews(self):
        views = self.repo.get_views_traffic()
        self.assertEqual(views.count, 93)
        self.assertEqual(views.uniques, 4)
        self.assertEqual(len(views.views), 5)
        view = views.views[0]
        self.assertEqual(view.uniques, 4)
        self.assertEqual(
            view.timestamp,
            datetime(2018, 11, 27, 0, 0, tzinfo=timezone.utc),
        )
        self.assertEqual(view.count, 56)
        self.assertEqual(
            repr(view),
            "Traffic(uniques=4, timestamp=2018-11-27 00:00:00+00:00, count=56)",
        )

    def testGetClones(self):
        clones = self.repo.get_clones_traffic()
        self.assertEqual(clones.count, 4)
        self.assertEqual(clones.uniques, 4)
        self.assertEqual(len(clones.clones), 1)
        clone = clones.clones[0]
        self.assertEqual(clone.uniques, 4)
        self.assertEqual(
            clone.timestamp,
            datetime(2018, 11, 27, 0, 0, tzinfo=timezone.utc),
        )
        self.assertEqual(clone.count, 4)
        self.assertEqual(
            repr(clone),
            "Traffic(uniques=4, timestamp=2018-11-27 00:00:00+00:00, count=4)",
        )