summaryrefslogtreecommitdiffstats
path: root/python/python-flufl-lock.spec
blob: 409fe8a1b2545ff847cf40d891dbbbb411ab11d4 (plain)
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
%global srcname flufl-lock
%global pypi_name flufl.lock

Name:           python-%{srcname}
Version:        6.0
Release:        %autorelease
Summary:        NFS-safe file locking with timeouts for POSIX and Windows
License:        ASL 2.0
URL:            https://flufllock.readthedocs.io/
Source0:        %{pypi_source %{pypi_name}}

BuildArch:      noarch

BuildRequires:  python%{python3_pkgversion}-devel
BuildRequires:  python%{python3_pkgversion}-setuptools

%global _description %{expand:
NFS-safe file locking with timeouts for POSIX and Windows.

The flufl.lock library provides an NFS-safe file-based locking algorithm
influenced by the GNU/Linux open(2) manpage, under the description of the O_EXCL
option.

    [] O_EXCL is broken on NFS file systems, programs which rely on it for
    performing locking tasks will contain a race condition. The solution for
    performing atomic file locking using a lockfile is to create a unique file
    on the same fs (e.g., incorporating hostname and pid), use link(2) to make a
    link to the lockfile. If link() returns 0, the lock is successful.
    Otherwise, use stat(2) on the unique file to check if its link count has
    increased to 2, in which case the lock is also successful.

The assumption made here is that there will be no outside interference, e.g. no
agent external to this code will ever link() to the specific lock files used.

Lock objects support lock-breaking so that you can’t wedge a process forever.
This is especially helpful in a web environment, but may not be appropriate for
all applications.

Locks have a lifetime, which is the maximum length of time the process expects
to retain the lock. It is important to pick a good number here because other
processes will not break an existing lock until the expected lifetime has
expired. Too long and other processes will hang; too short and you’ll end up
trampling on existing process locks – and possibly corrupting data. In a
distributed (NFS) environment, you also need to make sure that your clocks are
properly synchronized.}

%description %{_description}


%package -n python%{python3_pkgversion}-%{srcname}
Summary:        %{summary}

%description -n python%{python3_pkgversion}-%{srcname} %{_description}


%prep
%autosetup -p1 -n %{pypi_name}-%{version}


%generate_buildrequires
%pyproject_buildrequires -t


%build
%pyproject_wheel


%install
%pyproject_install
%pyproject_save_files flufl


%check
# upstream tox config invokes coverage tests
%pytest


%files -n python%{python3_pkgversion}-%{srcname} -f %{pyproject_files}
%license LICENSE
%doc README.rst
%{python3_sitelib}/%{pypi_name}-%{version}-py*-nspkg.pth


%changelog
%autochangelog