aboutsummaryrefslogtreecommitdiffstats
path: root/Mk/Uses/python.mk
blob: 3ab8ab7de3566a68c2f43961babf924278bd84e7 (plain) (blame)
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
# $FreeBSD$
#
# Provide support for Python related ports. This includes detecting Python
# interpreters, ports providing package and modules for python as well as
# consumer ports requiring Python at build or run time.
#
# Feature:  python
# Usage:    USES=python or USES=python:args
# Valid ARGS:   <version>, build, run, test
#
# version   If your port requires only some set of Python versions, you
#       can set this to [min]-[max] or min+ or -max or as an
#       explicit version or as a meta port version (eg. 3.3-3.4 for
#       [min]-[max], 2.7+ or -3.3 for min+ and -max, 2.7 for an
#       explicit version or 3 for a meta port version). Example:
#
#           USES=python:2.7     # Only use Python 2.7
#           USES=python:3.3+    # Use Python 3.3 or newer
#           USES=python:3.3-3.4 # Use Python 3.3 or 3.4
#           USES=python:-3.3    # Use any Python up to 3.3
#           USES=python:2       # Use the Python 2 meta port
#           USES=python     # Use the set default Python
#                       # version
#
# build     Indicates that Python is needed at build time and adds
#       it to BUILD_DEPENDS.
# run       Indicates that Python is needed at run time and adds
#       it to RUN_DEPENDS.
# test      Indicates that Python is needed at test time and adds
#       it to TEST_DEPENDS.
#
# If build, run and test are omitted, Python will be added as BUILD_DEPENDS,
# RUN_DEPENDS and TEST_DEPENDS. PYTHON_NO_DEPENDS can be set to not add any
# dependencies.
#
# Variables, which can be set by a user:
#
# PYTHON_VERSION    - The chosen Python interpreter including the version,
#             e.g. python2.7, python3.3, etc. This allows the user
#             to override the currently chosen default version and
#             to install the port for a specific Python version.
#             It must not be set by a port.
#
# Variables, which can be set by the port:
#
# USE_PYTHON        - A list of additional features and functionality to
#             enable. Supported features are:
#
#   concurrent  - Indicates that the port can be installed for
#             different python versions at the same time. The port
#             is supposed to use a unique prefix for certain
#             directories using USES=uniquefiles:dirs (see the
#             uniquefiles.mk Uses for details about the
#             directories), if set to yes. Binaries receive an
#             additional suffix, based on ${PYTHON_VER}.
#
#             The values for the uniquefiles USES are set as
#             follows:
#
#               UNIQUE_PREFIX=  ${PYTHON_PKGNAMEPREFIX}
#               UNIQUE_SUFFIX=  -${PYTHON_VER}
#
#             If the port is installed for the current default
#             python version, scripts and binaries in
#
#               ${PREFIX}/bin
#               ${PREFIX}/sbin
#               ${PREFIX}/libexec
#
#             are linked from the prefixed version to the
#             prefix-less original name, e.g.
#             bin/foo-2.7 --> bin/foo.
#
#   distutils   - Use distutils as do-configure, do-build and
#             do-install targets.
#
#   autoplist   - Automatically generates the packaging list for a
#             port that uses distutils when defined.
#             requires: distutils
#
#   py3kplist   - Automatically generates Python 3.x compatible
#             __pycache__ entries from a Python 2.x packaging list
#             when defined. Use this for ports that do *not* use
#             standard Python packaging mechanisms such as
#             distutils, and support *both* Python 2.x and 3.x.
#             Not needed, if USE_PYTHON=autoplist is set.
#
#   pythonprefix    - Says that the port installs in ${PYTHONBASE} instead
#             of ${PREFIX}.
#
#   noegginfo   - Skip an egg-info entry from plist, if defined.
#
# PYTHON_CMD        - Python's command line file name, including the
#             version number (used for dependencies).
#             default: ${PYTHONBASE}/bin/${PYTHON_VERSION}
#
# PYSETUP       - Name of the setup script used by the distutils
#             package.
#             default: setup.py
#
# PYDISTUTILS_PKGNAME
#           - Internal name in the distutils for egg-info.
#             default: ${PORTNAME}
#
# PYDISTUTILS_PKGVERSION
#           - Internal version in the distutils for egg-info.
#             default: ${PORTVERSION}
#
# PYDISTUTILS_CONFIGURE_TARGET
#           - Pass this command to distutils on configure stage.
#             default: config
#
# PYDISTUTILS_BUILD_TARGET
#           - Pass this command to distutils on build stage.
#             default: build
#
# PYDISTUTILS_INSTALL_TARGET
#           - Pass this command to distutils on install stage.
#             default: install
#
# PYDISTUTILS_CONFIGUREARGS
#           - Arguments to config with distutils.
#             default: <empty>
#
# PYDISTUTILS_BUILDARGS
#           - Arguments to build with distutils.
#             default: <empty>
#
# PYDISTUTILS_INSTALLARGS
#           - Arguments to install with distutils.
#             default: -c -O1 --prefix=${PREFIX} --single-version-externally-managed --root=${STAGEDIR}
#
# PYDISTUTILS_EGGINFO
#           - Canonical name for egg-info.
#             default: ${PYDISTUTILS_PKGNAME:C/[^A-Za-z0-9.]+/_/g}-${PYDISTUTILS_PKGVERSION:C/[^A-Za-z0-9.]+/_/g}-py${PYTHON_VER}.egg-info
#
# The following variables can be read by ports and must not be modified:
#
# PYTHONBASE        - The installation prefix of the chosen Python
#             interpreter, e.g. /usr/local
#
# PYTHON_PORTVERSION
#           - Version number suitable for ${PORTVERSION}.
#
# PYTHON_PORTSDIR   - The port directory of the chosen Python interpreter
#
# PYTHON_REL        - The release number of the chosen Python interpreter
#             without dots, e.g. 2706, 3401, ...
#
# PYTHON_SUFFIX     - The major-minor release number of the chosen Python
#             interpreter without dots, e.g. 27, 34, ...
#             Used for prefixes and suffixes.
#
# PYTHON_MAJOR_VER  - The major release version of the chosen Python
#             interpreter, e.g. 2, 3, ...
#
# PYTHON_VER        - The major-minor release version of the chosen Python
#             interpreter, e.g. 2.7, 3.4, ...
#
# PYTHON_ABIVER     - Additional ABI flags set by the chosen Python
#             interpreter, e.g. md
#
# PYTHON_INCLUDEDIR - Location of the Python include files.
#             default: ${PYTHONBASE}/include/${PYTHON_VERSION}
#
# PYTHON_LIBDIR     - Base of the python library tree
#             default: ${PYTHONBASE}/lib/${PYTHON_VERSION}
#
# PYTHON_SITELIBDIR - Location of the site-packages tree. Don't change,
#             unless you know what you do.
#             default: ${PYTHON_LIBDIR}/site-packages
#
# There are PREFIX-clean variants of the PYTHON_*DIR variables above.
# They are meant to be used by ports instead of the above variables, so the
# ports respect ${PREFIX} (unless USE_PYTHON=pythonprefix is specified).
#
# PYTHONPREFIX_INCLUDEDIR   default: ${PREFIX}/include/${PYTHON_VERSION}
# PYTHONPREFIX_LIBDIR       default: ${PREFIX}/lib/${PYTHON_VERSION}
# PYTHONPREFIX_SITELIBDIR   default: ${PYTHONPREFIX_LIBDIR}/site-packages
#
# PYTHON_PLATFORM   - Python's idea of the OS release.
#             This is faked with ${OPSYS} and ${OSREL} until we
#             find out how to delay defining a variable until
#             after a certain target has been built.
#
# PYTHON_PKGNAMEPREFIX
#           - Use this as a ${PKGNAMEPREFIX} to distinguish
#             packages for different Python versions.
#             default: py${PYTHON_SUFFIX}-
#
# Using USES=python.mk also will add some useful entries to PLIST_SUB:
#
#   PYTHON_INCLUDEDIR=${PYTHONPREFIX_INCLUDEDIR:S;${PREFIX}/;;}
#   PYTHON_LIBDIR=${PYTHONPREFIX_LIBDIR:S;${PREFIX}/;;}
#   PYTHON_PLATFORM=${PYTHON_PLATFORM}
#   PYTHON_PYOEXTENSION=${PYTHON_PYOEXTENSION}
#   PYTHON_SITELIBDIR=${PYTHONPREFIX_SITELIBDIR:S;${PREFIX}/;;}
#   PYTHON_SUFFIX=${PYTHON_SUFFIX}
#   PYTHON_VER=${PYTHON_VER}
#   PYTHON_VERSION=${PYTHON_VERSION}
#
# and PYTHON2 and PYTHON3 will be set according to the Python version:
#
#   PYTHON2="" PYTHON3="@comment " for Python 2.x
#   PYTHON2="@comment " PYTHON3="" for Python 3.x
#
# Deprecated variables, which exist for compatibility and will be removed
# soon:
#
# PYTHON_DEFAULT_VERSION
# PYTHON2_DEFAULT_VERSION
# PYTHON3_DEFAULT_VERSION
#           - Deprecated, use PYTHON[2,3]_DEFAULT instead,
#             see bsd.default-versions.mk
#
# PYTHON_PKGNAMESUFFIX
#           - Deprecated, use PYTHON_PKGNAMEPREFIX instead
#             default: -py${PYTHON_SUFFIX}
#
# PYDISTUTILS_INSTALLNOSINGLE
#           - Deprecated without replacement
#
# MAINTAINER: python@FreeBSD.org

.if !defined(_INCLUDE_USES_PYTHON_MK)
_INCLUDE_USES_PYTHON_MK=    yes

# What Python version and what Python interpreters are currently supported?
# When adding a version, please keep the comment in
# Mk/bsd.default-versions.mk in sync.
_PYTHON_VERSIONS=       2.7 3.6 3.5 3.4 3.3 # preferred first
_PYTHON_PORTBRANCH=     2.7     # ${_PYTHON_VERSIONS:[1]}
_PYTHON_BASECMD=        ${LOCALBASE}/bin/python
_PYTHON_RELPORTDIR=     lang/python

# Make each individual feature available as _PYTHON_FEATURE_<FEATURENAME>
.for var in ${USE_PYTHON}
_PYTHON_FEATURE_${var:tu}=  yes
.endfor

# Make sure that no dependency or some other environment variable
# pollutes the build/run dependency detection
.undef _PYTHON_BUILD_DEP
.undef _PYTHON_RUN_DEP
.undef _PYTHON_TEST_DEP
_PYTHON_ARGS=       ${python_ARGS:S/,/ /g}
.if ${_PYTHON_ARGS:Mbuild}
_PYTHON_BUILD_DEP=  yes
_PYTHON_ARGS:=      ${_PYTHON_ARGS:Nbuild}
.endif
.if ${_PYTHON_ARGS:Mrun}
_PYTHON_RUN_DEP=    yes
_PYTHON_ARGS:=      ${_PYTHON_ARGS:Nrun}
.endif
.if ${_PYTHON_ARGS:Mtest}
_PYTHON_TEST_DEP=   yes
_PYTHON_ARGS:=      ${_PYTHON_ARGS:Ntest}
.endif

# The port does not specify a build, run or test dependency, assume all are
# required.
.if !defined(_PYTHON_BUILD_DEP) && !defined(_PYTHON_RUN_DEP) && \
    !defined(_PYTHON_TEST_DEP) && !defined(PYTHON_NO_DEPENDS)
_PYTHON_BUILD_DEP=  yes
_PYTHON_RUN_DEP=    yes
_PYTHON_TEST_DEP=   yes
.endif

.if defined(PYTHON_DEFAULT_VERSION)
WARNING+=   "PYTHON_DEFAULT_VERSION is defined, consider using DEFAULT_VERSIONS=python=${PYTHON_DEFAULT_VERSION:S/^python//} instead"
.endif
.if defined(PYTHON2_DEFAULT_VERSION)
WARNING+=   "PYTHON2_DEFAULT_VERSION is defined, consider using DEFAULT_VERSIONS=python2=${PYTHON2_DEFAULT_VERSION:S/^python//} instead"
.endif
.if defined(PYTHON3_DEFAULT_VERSION)
WARNING+=   "PYTHON3_DEFAULT_VERSION is defined, consider using DEFAULT_VERSIONS=python3=${PYTHON3_DEFAULT_VERSION:S/^python//} instead"
.endif

.if exists(${LOCALBASE}/bin/python)
.if !defined(_PYTHON_DEFAULT_VERSION)
_PYTHON_DEFAULT_VERSION!=   (${LOCALBASE}/bin/python -c \
        'import sys; print("%d.%d" % sys.version_info[:2])' 2> /dev/null \
        || ${ECHO_CMD} ${_PYTHON_PORTBRANCH}) | ${TAIL} -1
.endif
_EXPORTED_VARS+=    _PYTHON_DEFAULT_VERSION
.if defined(PYTHON_DEFAULT) && (${PYTHON_DEFAULT} != ${_PYTHON_DEFAULT_VERSION})
WARNING+=   "Your requested default python version ${PYTHON_DEFAULT} is different from the installed default python interpreter version ${_PYTHON_DEFAULT_VERSION}"
.endif
PYTHON_DEFAULT_VERSION=     python${_PYTHON_DEFAULT_VERSION}
.else
PYTHON_DEFAULT_VERSION=     python${PYTHON_DEFAULT}
.endif # exists(${LOCALBASE}/bin/python)

# Is only a meta-port version defined?
.if ${PYTHON_DEFAULT_VERSION} == "python2"
PYTHON2_DEFAULT_VERSION?=   python${PYTHON2_DEFAULT}
.elif ${PYTHON_DEFAULT_VERSION:R} == "python2"
PYTHON2_DEFAULT_VERSION=    ${PYTHON_DEFAULT_VERSION}
.else
PYTHON2_DEFAULT_VERSION?=   python${PYTHON2_DEFAULT}
.endif
.if ${PYTHON_DEFAULT_VERSION} == "python3"
PYTHON3_DEFAULT_VERSION?=   python${PYTHON3_DEFAULT}
.elif ${PYTHON_DEFAULT_VERSION:R} == "python3"
 PYTHON3_DEFAULT_VERSION=   ${PYTHON_DEFAULT_VERSION}
.else
PYTHON3_DEFAULT_VERSION?=   python${PYTHON3_DEFAULT}
.endif

.if ${_PYTHON_ARGS} == "2"
_PYTHON_ARGS=       ${PYTHON2_DEFAULT_VERSION:S/^python//}
_WANTS_META_PORT=   2
.elif ${_PYTHON_ARGS} == "3"
_PYTHON_ARGS=       ${PYTHON3_DEFAULT_VERSION:S/^python//}
_WANTS_META_PORT=   3
.endif  # ${_PYTHON_ARGS} == "2"

.if defined(PYTHON_VERSION)
# A port/user requests a specific python version for its dependencies via
# DEPENDS_ARGS, since it requires the specific python version itself.
# Several things can happen now:
#   a) the dependency supports the requested version -> everything's fine
#   b) the dependency does not support the requested version
#       1) the dependency works in a way that the different python
#          versions do not matter -> everything's fine
#       2) the dependency is likely to break due to the conflict
#          nothing's fine
#
# b.2) needs to be resolved. Due to the complexity of how different pieces of
# software are built, we can't solve this automatically. Instead, let's assume
# that maintainers know what they are doing and assume PYTHON_VERSION to be a
# hint. Just warn maintainers, if the versions do not match
# (_PYTHON_VERSION_NONSUPPORTED).
_PYTHON_VERSION:=   ${PYTHON_VERSION:S/^python//}
.else
_PYTHON_VERSION:=   ${PYTHON_DEFAULT_VERSION:S/^python//}
.endif # defined(PYTHON_VERSION)

# Validate Python version whether it meets the version restriction.
_PYTHON_VERSION_CHECK:=     ${_PYTHON_ARGS:C/^([1-9]\.[0-9])$/\1-\1/}
_PYTHON_VERSION_MINIMUM_TMP:=   ${_PYTHON_VERSION_CHECK:C/([1-9]\.[0-9])[-+].*/\1/}
_PYTHON_VERSION_MINIMUM:=   ${_PYTHON_VERSION_MINIMUM_TMP:M[1-9].[0-9]}
_PYTHON_VERSION_MAXIMUM_TMP:=   ${_PYTHON_VERSION_CHECK:C/.*-([1-9]\.[0-9])/\1/}
_PYTHON_VERSION_MAXIMUM:=   ${_PYTHON_VERSION_MAXIMUM_TMP:M[1-9].[0-9]}

.undef _PYTHON_VERSION_NONSUPPORTED
.if !empty(_PYTHON_VERSION_MINIMUM) && (${_PYTHON_VERSION} < ${_PYTHON_VERSION_MINIMUM})
_PYTHON_VERSION_NONSUPPORTED=   ${_PYTHON_VERSION_MINIMUM} at least
.elif !empty(_PYTHON_VERSION_MAXIMUM) && (${_PYTHON_VERSION} > ${_PYTHON_VERSION_MAXIMUM})
_PYTHON_VERSION_NONSUPPORTED=   ${_PYTHON_VERSION_MAXIMUM} at most
.endif

# If we have an unsupported version of Python, try another.
.if defined(_PYTHON_VERSION_NONSUPPORTED)
.if defined(PYTHON_VERSION) || defined(PYTHON_CMD)
_PV:=       ${_PYTHON_VERSION}  # preserve the specified python version
IGNORE=     needs Python ${_PYTHON_VERSION_NONSUPPORTED}, but ${_PV} was specified
.endif # defined(PYTHON_VERSION) || defined(PYTHON_CMD)
.undef _PYTHON_VERSION
.for ver in ${PYTHON2_DEFAULT} ${PYTHON3_DEFAULT} ${_PYTHON_VERSIONS}
__VER=      ${ver}
.if !defined(_PYTHON_VERSION) && \
    !(!empty(_PYTHON_VERSION_MINIMUM) && ( \
        ${__VER} < ${_PYTHON_VERSION_MINIMUM})) && \
    !(!empty(_PYTHON_VERSION_MAXIMUM) && ( \
        ${__VER} > ${_PYTHON_VERSION_MAXIMUM}))
_PYTHON_VERSION=    ${ver}
.endif
.endfor
.if !defined(_PYTHON_VERSION)
IGNORE=     needs an unsupported version of Python
.endif
.endif  # defined(_PYTHON_VERSION_NONSUPPORTED)

# Pass PYTHON_VERSION down the dependency chain. This ensures that
# port A -> B -> C all will use the same python version and do not
# try to find a different one, if the passed version fits into
# the supported version range.
PYTHON_VERSION?=    python${_PYTHON_VERSION}
.if !defined(PYTHON_NO_DEPENDS) && \
    ${PYTHON_VERSION} != ${PYTHON_DEFAULT_VERSION}
DEPENDS_ARGS+=      PYTHON_VERSION=${PYTHON_VERSION}
.endif

# NOTE:
#
#  PYTHON_VERSION will hold whatever is passed down the dependency chain.
#  If a user runs `make PYTHON_VERSION=python3.3, PYTHON_VERSION will be
#  set to 'python3.3'. A port however may require a different version,
#  which is stored (above) in _PYTHON_VERSION.
#  Every python bit below hence should use python${_PYTHON_VERSION}, since
#  this is the value, the _port_ requires
#

# Got the correct python version, set some publicly accessible variables
PYTHON_VER=     ${_PYTHON_VERSION}
PYTHON_SUFFIX=      ${_PYTHON_VERSION:S/.//g}
PYTHON_MAJOR_VER=   ${PYTHON_VER:R}
PYTHON_REL=     # empty
PYTHON_ABIVER=      # empty
PYTHON_PORTSDIR=    ${_PYTHON_RELPORTDIR}${PYTHON_SUFFIX}
# Protect partial checkouts from Mk/Scripts/functions.sh:export_ports_env().
.if !defined(_PORTS_ENV_CHECK) || exists(${PORTSDIR}/${PYTHON_PORTSDIR})
.include "${PORTSDIR}/${PYTHON_PORTSDIR}/Makefile.version"
.endif
# Create a 4 integer version string, prefixing 0 to the last token if
# it's a single character. Only use the the first 3 tokens of
# PORTVERSION to support pre-release versions (rc3, alpha4, etc) of
# any Python port (lang/pythonXY)
PYTHON_REL= ${PYTHON_PORTVERSION:C/^([0-9]+\.[0-9]+\.[0-9]+).*/\1/:C/\.([0-9]+)$/.0\1/:C/\.0?([0-9][0-9])$/.\1/:S/.//g}

# Might be overridden by calling ports
PYTHON_CMD?=        ${_PYTHON_BASECMD}${_PYTHON_VERSION}
.if ${PYTHON_VER} != 2.7
.if exists(${PYTHON_CMD}-config)
PYTHON_ABIVER!=     ${PYTHON_CMD}-config --abiflags
.else
# Default ABI flags for lang/python3x ports
PYTHON_ABIVER=      m
.endif
.endif

.if !defined(PYTHONBASE)
PYTHONBASE!=    (${PYTHON_CMD} -c 'import sys; print(sys.prefix)' \
            2> /dev/null || ${ECHO_CMD} ${LOCALBASE}) | ${TAIL} -1
.endif
_EXPORTED_VARS+=    PYTHONBASE

PYTHON_INCLUDEDIR=  ${PYTHONBASE}/include/python${_PYTHON_VERSION}${PYTHON_ABIVER}
PYTHON_LIBDIR=      ${PYTHONBASE}/lib/python${_PYTHON_VERSION}
PYTHON_PLATFORM=    ${OPSYS:tl}${OSREL:C/\.[0-9.]*//}
PYTHON_SITELIBDIR=  ${PYTHON_LIBDIR}/site-packages
PYTHON_PKGNAMEPREFIX=   py${PYTHON_SUFFIX}-
PYTHON_PKGNAMESUFFIX=   -py${PYTHON_SUFFIX}

PYTHONPREFIX_INCLUDEDIR=    ${PYTHON_INCLUDEDIR:S;${PYTHONBASE};${PREFIX};}
PYTHONPREFIX_LIBDIR=        ${PYTHON_LIBDIR:S;${PYTHONBASE};${PREFIX};}
PYTHONPREFIX_SITELIBDIR=    ${PYTHON_SITELIBDIR:S;${PYTHONBASE};${PREFIX};}

# Used for recording the installed files.
_PYTHONPKGLIST= ${WRKDIR}/.PLIST.pymodtmp

# PEP 0488 (https://www.python.org/dev/peps/pep-0488/)
.if ${PYTHON_REL} < 3500
PYTHON_PYOEXTENSION=    pyo
.else
PYTHON_PYOEXTENSION=    opt-1.pyc
.endif

# Ports bound to a certain python version SHOULD
# - use the PYTHON_PKGNAMEPREFIX
# - use directories using the PYTHON_PKGNAMEPREFIX
# - install binaries using the required PYTHON_VER, with
#   the default python version creating a symlink to the original binary
#   name (for staging-aware ports).
#
# What makes a port 'bound' to a certain python version?
# - it installs data into PYTHON_SITELIBDIR, PYTHON_INCLUDEDIR, ...
# - it links against libpython*.so
# - it uses USE_PYTHON=distutils
#

.if defined(_PYTHON_FEATURE_CONCURRENT)
_USES_POST+=        uniquefiles:dirs
.if ${PYTHON_VERSION} == ${PYTHON_DEFAULT_VERSION}
UNIQUE_DEFAULT_LINKS=   yes
.else
UNIQUE_DEFAULT_LINKS=   no
.endif
UNIQUE_PREFIX=      ${PYTHON_PKGNAMEPREFIX}
UNIQUE_SUFFIX=      -${PYTHON_VER}

.if defined(_PYTHON_FEATURE_AUTOPLIST)
UNIQUE_FIND_SUFFIX_FILES=   \
    ${SED} -e 's|^${PREFIX}/||' ${_PYTHONPKGLIST} ${TMPPLIST} | \
    ${EGREP} -e '^bin/.*$$|^sbin/.*$$|^libexec/.*$$'
.else
UNIQUE_FIND_SUFFIX_FILES=   \
    ${EGREP} -he '^bin/.*$$|^sbin/.*$$|^libexec/.*$$' ${TMPPLIST} 2>/dev/null
.endif
.endif # defined(_PYTHON_FEATURE_CONCURRENT)

_CURRENTPORT:=  ${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}
.if defined(_PYTHON_FEATURE_DISTUTILS) && \
    ${_CURRENTPORT} != ${PYTHON_PKGNAMEPREFIX}setuptools
BUILD_DEPENDS+=     ${PYTHON_PKGNAMEPREFIX}setuptools>0:devel/${PYTHON_PKGNAMEPREFIX}setuptools
RUN_DEPENDS+=       ${PYTHON_PKGNAMEPREFIX}setuptools>0:devel/${PYTHON_PKGNAMEPREFIX}setuptools
.endif

# distutils support
PYSETUP?=       setup.py
PYDISTUTILS_SETUP?= -c \
    "import sys; import setuptools; \
    __file__='${PYSETUP}'; sys.argv[0]='${PYSETUP}'; \
    exec(compile(open(__file__, 'rb').read().replace(b'\\r\\n', b'\\n'), __file__, 'exec'))"
PYDISTUTILS_CONFIGUREARGS?= # empty
PYDISTUTILS_BUILDARGS?=     # empty
PYDISTUTILS_INSTALLARGS?=   -c -O1 --prefix=${PREFIX}
.if defined(_PYTHON_FEATURE_DISTUTILS)
. if !defined(PYDISTUTILS_INSTALLNOSINGLE)
PYDISTUTILS_INSTALLARGS+=   --single-version-externally-managed
. endif
PYDISTUTILS_INSTALLARGS+=   --root=${STAGEDIR}
.endif
PYDISTUTILS_INSTALLARGS:=   --record ${_PYTHONPKGLIST} \
        ${PYDISTUTILS_INSTALLARGS}

PYDISTUTILS_PKGNAME?=   ${PORTNAME}
PYDISTUTILS_PKGVERSION?=${PORTVERSION}
PYDISTUTILS_EGGINFO?=   ${PYDISTUTILS_PKGNAME:C/[^A-Za-z0-9.]+/_/g}-${PYDISTUTILS_PKGVERSION:C/[^A-Za-z0-9.]+/_/g}-py${PYTHON_VER}.egg-info
PYDISTUTILS_EGGINFODIR?=${STAGEDIR}${PYTHONPREFIX_SITELIBDIR}

.if !defined(_PYTHON_FEATURE_NOEGGINFO) && \
    !defined(_PYTHON_FEATURE_AUTOPLIST) && \
    defined(_PYTHON_FEATURE_DISTUTILS) && \
    defined(PYTHON_REL)
_USES_stage+=   933:add-plist-egginfo
add-plist-egginfo:
. for egginfo in ${PYDISTUTILS_EGGINFO}
    if [ -d "${PYDISTUTILS_EGGINFODIR}/${egginfo}" ]; then \
        ${LS} ${PYDISTUTILS_EGGINFODIR}/${egginfo} | while read f; do \
            ${ECHO_CMD} ${PYDISTUTILS_EGGINFODIR:S;^${STAGEDIR}${PREFIX}/;;}/${egginfo}/$${f} >> ${TMPPLIST}; \
        done; \
    fi;
. endfor
.endif

.if defined(_PYTHON_FEATURE_AUTOPLIST) && defined(_PYTHON_FEATURE_DISTUTILS)
_RELSITELIBDIR= ${PYTHONPREFIX_SITELIBDIR:S;${PREFIX}/;;}
_RELLIBDIR=     ${PYTHONPREFIX_LIBDIR:S;${PREFIX}/;;}

_USES_stage+=   934:add-plist-pymod
add-plist-pymod:
    @${SED} -e 's|^${STAGEDIR}${PREFIX}/||' \
        -e 's|^${PREFIX}/||' \
        -e 's|^\(man/.*man[0-9]\)/\(.*\.[0-9]\)$$|\1/\2.gz|' \
        -e 's|[[:alnum:]|[:space:]]*/\.\./*||g; s|/\./|/|g' \
        ${_PYTHONPKGLIST} | ${SORT} >> ${TMPPLIST}

.else
.if ${PYTHON_REL} >= 3200 && defined(_PYTHON_FEATURE_PY3KPLIST)
# When Python version is 3.2+ we rewrite all the filenames
# of TMPPLIST that end with .py[co], so that they conform
# to PEP 3147 (see http://www.python.org/dev/peps/pep-3147/)
PYMAGICTAG=     ${PYTHON_CMD} -c 'import imp; print(imp.get_tag())'
_USES_stage+=   935:add-plist-python
add-plist-python:
    @${AWK} '\
        /\.py[co]$$/ && !($$0 ~ "/" pc "/") {id = match($$0, /\/[^\/]+\.py[co]$$/); if (id != 0) {d = substr($$0, 1, RSTART - 1); dirs[d] = 1}; sub(/\.pyc$$/,  "." mt "&"); sub(/\.pyo$$/, "." mt "." pyo); sub(/[^\/]+\.py[co]$$/, pc "/&"); print; next} \
        /^@dirrm / {d = substr($$0, 8); if (d in dirs) {print $$0 "/" pc}; print $$0; next} \
        /^@dirrmtry / {d = substr($$0, 11); if (d in dirs) {print $$0 "/" pc}; print $$0; next} \
        {print} \
        ' \
        pc="__pycache__" mt="$$(${PYMAGICTAG})" pyo="${PYTHON_PYOEXTENSION}" \
        ${TMPPLIST} > ${TMPPLIST}.pyc_tmp
    @${MV} ${TMPPLIST}.pyc_tmp ${TMPPLIST}
.endif # ${PYTHON_REL} >= 3200 && defined(_PYTHON_FEATURE_PY3KPLIST)
.endif # defined(_PYTHON_FEATURE_AUTOPLIST) && defined(_PYTHON_FEATURE_DISTUTILS)

# Fix for programs that build python from a GNU auto* environment
CONFIGURE_ENV+= PYTHON="${PYTHON_CMD}"

# By default CMake picks up the highest available version of Python package.
# Enforce the version required by the port or the default.
CMAKE_ARGS+=    -DPython_ADDITIONAL_VERSIONS=${PYTHON_VER}

# Python 3rd-party modules
PYGAME=     ${PYTHON_PKGNAMEPREFIX}game>0:devel/py-game
PYNUMERIC=  ${PYTHON_SITELIBDIR}/Numeric/Numeric.py:math/py-numeric
PYNUMPY=    ${PYTHON_SITELIBDIR}/numpy/core/numeric.py:math/py-numpy

# dependencies
.if defined(_PYTHON_BUILD_DEP)
BUILD_DEPENDS+= ${PYTHON_CMD}:${PYTHON_PORTSDIR}
.if defined(_WANTS_META_PORT)
BUILD_DEPENDS+= python${_WANTS_META_PORT}:${_PYTHON_RELPORTDIR}${_WANTS_META_PORT}
.endif
.endif
.if defined(_PYTHON_RUN_DEP)
RUN_DEPENDS+=   ${PYTHON_CMD}:${PYTHON_PORTSDIR}
.if defined(_WANTS_META_PORT)
RUN_DEPENDS+=   python${_WANTS_META_PORT}:${_PYTHON_RELPORTDIR}${_WANTS_META_PORT}
.endif
.endif
.if defined(_PYTHON_TEST_DEP)
TEST_DEPENDS+=  ${PYTHON_CMD}:${PYTHON_PORTSDIR}
.if defined(_WANTS_META_PORT)
TEST_DEPENDS+=  python${_WANTS_META_PORT}:${_PYTHON_RELPORTDIR}${_WANTS_META_PORT}
.endif
.endif

# set $PREFIX as Python's one
.if defined(_PYTHON_FEATURE_PYTHONPREFIX)
PREFIX=     ${PYTHONBASE}
.endif

# Substitutions for pkg-plist
# Use a short form of the PYTHONPREFIX_*DIR variables; we don't need the
# base directory in the plist file.
PLIST_SUB+= PYTHON_INCLUDEDIR=${PYTHONPREFIX_INCLUDEDIR:S;${PREFIX}/;;} \
        PYTHON_LIBDIR=${PYTHONPREFIX_LIBDIR:S;${PREFIX}/;;} \
        PYTHON_PLATFORM=${PYTHON_PLATFORM} \
        PYTHON_PYOEXTENSION=${PYTHON_PYOEXTENSION} \
        PYTHON_SITELIBDIR=${PYTHONPREFIX_SITELIBDIR:S;${PREFIX}/;;} \
        PYTHON_SUFFIX=${PYTHON_SUFFIX} \
        PYTHON_VER=${PYTHON_VER} \
        PYTHON_VERSION=${PYTHON_VERSION}
.if ${PYTHON_REL} < 3000
PLIST_SUB+= PYTHON2="" PYTHON3="@comment "
.else
PLIST_SUB+= PYTHON2="@comment " PYTHON3=""
.endif

_USES_POST+=    python
.endif # _INCLUDE_USES_PYTHON_MK

.if defined(_POSTMKINCLUDED) && !defined(_INCLUDE_USES_PYTHON_POST_MK)
_INCLUDE_USES_PYTHON_POST_MK=   yes

# py-distutils support
PYDISTUTILS_CONFIGURE_TARGET?=  config
PYDISTUTILS_BUILD_TARGET?=  build
PYDISTUTILS_INSTALL_TARGET?=    install

.if defined(_PYTHON_FEATURE_DISTUTILS)
LDSHARED?=  ${CC} -shared
MAKE_ENV+=  LDSHARED="${LDSHARED}" PYTHONDONTWRITEBYTECODE= PYTHONOPTIMIZE=

.if !target(do-configure) && !defined(HAS_CONFIGURE) && !defined(GNU_CONFIGURE)
do-configure:
    @(cd ${BUILD_WRKSRC}; ${SETENV} ${MAKE_ENV} ${PYTHON_CMD} ${PYDISTUTILS_SETUP} ${PYDISTUTILS_CONFIGURE_TARGET} ${PYDISTUTILS_CONFIGUREARGS})
.endif

.if !target(do-build)
do-build:
    @(cd ${BUILD_WRKSRC}; ${SETENV} ${MAKE_ENV} ${PYTHON_CMD} ${PYDISTUTILS_SETUP} ${PYDISTUTILS_BUILD_TARGET} ${PYDISTUTILS_BUILDARGS})
.endif

.if !target(do-install)
do-install:
    @(cd ${INSTALL_WRKSRC}; ${SETENV} ${MAKE_ENV} ${PYTHON_CMD} ${PYDISTUTILS_SETUP} ${PYDISTUTILS_INSTALL_TARGET} ${PYDISTUTILS_INSTALLARGS})
.endif
.endif # defined(_PYTHON_FEATURE_DISTUTILS)
.endif # defined(_POSTMKINCLUDED) && !defined(_INCLUDE_USES_PYTHON_POST_MK)