util/misc.py
author Edouard Tisserant <edouard.tisserant@gmail.com>
Tue, 20 Aug 2024 01:51:08 +0200
changeset 3978 22ba103801ee
parent 3750 f62625418bff
permissions -rw-r--r--
Merge remote-tracking branch 'origin/python3' into python3
1511
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
     1
#!/usr/bin/env python
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
     2
# -*- coding: utf-8 -*-
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
     3
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
     4
# This file is part of Beremiz, a Integrated Development Environment for
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
     5
# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
     6
#
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
     7
# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
     8
#
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
     9
# See COPYING file for copyrights details.
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    10
#
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    11
# This program is free software; you can redistribute it and/or
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    12
# modify it under the terms of the GNU General Public License
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    13
# as published by the Free Software Foundation; either version 2
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    14
# of the License, or (at your option) any later version.
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    15
#
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    16
# This program is distributed in the hope that it will be useful,
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    17
# but WITHOUT ANY WARRANTY; without even the implied warranty of
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    19
# GNU General Public License for more details.
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    20
#
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    21
# You should have received a copy of the GNU General Public License
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    22
# along with this program; if not, write to the Free Software
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    23
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
91538d0c242c add copyright notices to python files where there were missing, that
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1388
diff changeset
    24
725
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    25
"""
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    26
Misc definitions
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    27
"""
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    28
1853
47a3f39bead0 fix pylint warning "(relative-import) Relative import 'Y', should be 'X.Y'"
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
    29
3750
f62625418bff automated conversion using 2to3-3.9 tool
GP Orcullo <kinsamanka@gmail.com>
parents: 3481
diff changeset
    30
3479
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    31
import os,sys
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    32
import random
2456
7373e3048167 python3 support: pylint,W1610 # (reduce-builtin) reduce built-in referenced
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1953
diff changeset
    33
from functools import reduce
806
abf1afc1f04d Fix bug when closing IECCodeView and IECRawCodeView, reopening them was impossible
laurent
parents: 781
diff changeset
    34
1853
47a3f39bead0 fix pylint warning "(relative-import) Relative import 'Y', should be 'X.Y'"
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
    35
from util.BitmapLibrary import AddBitmapFolder
47a3f39bead0 fix pylint warning "(relative-import) Relative import 'Y', should be 'X.Y'"
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
    36
from util.TranslationCatalogs import AddCatalog
47a3f39bead0 fix pylint warning "(relative-import) Relative import 'Y', should be 'X.Y'"
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
    37
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1735
diff changeset
    38
725
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    39
def CheckPathPerm(path):
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1735
diff changeset
    40
    """ Helper func to check path write permission """
725
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    41
    if path is None or not os.path.isdir(path):
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    42
        return False
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    43
    for root, dirs, files in os.walk(path):
1719
704c7036db85 skip hidden files and directories on permission check
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
    44
        files = [f for f in files if not f[0] == '.']
704c7036db85 skip hidden files and directories on permission check
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
    45
        dirs[:] = [d for d in dirs if not d[0] == '.']
3479
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    46
        if sys.platform.startswith('win'):
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    47
            try:
3481
563996733dba Various fixes to make svghmi_traffic_light example bahave on windows.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3479
diff changeset
    48
                testdirpath = os.path.join(root, "testdir_" + str(random.randint(0, 4294967296)))
3479
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    49
                os.mkdir(testdirpath)
3481
563996733dba Various fixes to make svghmi_traffic_light example bahave on windows.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3479
diff changeset
    50
                os.rmdir(testdirpath)
3479
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    51
            except:
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    52
                return False
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    53
        else:
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    54
            if os.access(root, os.W_OK) is not True:
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    55
                return False
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    56
74cfeff6a011 IDE: fix permission checking on windows for IDE project directory.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 3475
diff changeset
    57
        for name in files:
3475
ee665dca07fa IDE: better permission checking when opening a project.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2456
diff changeset
    58
            if os.access(os.path.join(root, name), os.W_OK) is not True:
1719
704c7036db85 skip hidden files and directories on permission check
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
    59
                return False
725
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    60
    return True
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    61
1953
5736d25bb393 PEP8 and PyLint conformance: whitespaces and stuff
Edouard Tisserant
parents: 1930
diff changeset
    62
1923
65edbc03fdbf ClassImporter now accepts string, callable or class, for compatibility with some old extensions.
Edouard Tisserant
parents: 1920
diff changeset
    63
def GetClassImporter(param):
1920
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    64
    """
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    65
    is used to resolve library class names in features.py
1923
65edbc03fdbf ClassImporter now accepts string, callable or class, for compatibility with some old extensions.
Edouard Tisserant
parents: 1920
diff changeset
    66
    if param is a string, returns a callable that return the class pointed by param
65edbc03fdbf ClassImporter now accepts string, callable or class, for compatibility with some old extensions.
Edouard Tisserant
parents: 1920
diff changeset
    67
    if a class is given, then returns a callable that returns the given class.
1920
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    68
    """
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1735
diff changeset
    69
1923
65edbc03fdbf ClassImporter now accepts string, callable or class, for compatibility with some old extensions.
Edouard Tisserant
parents: 1920
diff changeset
    70
    if isinstance(param, str):
1920
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    71
        def factory():
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    72
            # on-demand import, only when using class
1923
65edbc03fdbf ClassImporter now accepts string, callable or class, for compatibility with some old extensions.
Edouard Tisserant
parents: 1920
diff changeset
    73
            mod = __import__(param.rsplit('.', 1)[0])
65edbc03fdbf ClassImporter now accepts string, callable or class, for compatibility with some old extensions.
Edouard Tisserant
parents: 1920
diff changeset
    74
            return reduce(getattr, param.split('.')[1:], mod)
1920
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    75
        return factory
1930
e6de7df5f401 Removed dead code
Edouard Tisserant
parents: 1923
diff changeset
    76
    else:
1953
5736d25bb393 PEP8 and PyLint conformance: whitespaces and stuff
Edouard Tisserant
parents: 1930
diff changeset
    77
        return lambda: param
1388
67c9a9482d24 Factorized bitmap and i18n resources loading in between PLCopenEditor and Beremiz. Now in utils/misc.py
Edouard Tisserant
parents: 815
diff changeset
    78
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1735
diff changeset
    79
1388
67c9a9482d24 Factorized bitmap and i18n resources loading in between PLCopenEditor and Beremiz. Now in utils/misc.py
Edouard Tisserant
parents: 815
diff changeset
    80
def InstallLocalRessources(CWD):
67c9a9482d24 Factorized bitmap and i18n resources loading in between PLCopenEditor and Beremiz. Now in utils/misc.py
Edouard Tisserant
parents: 815
diff changeset
    81
    # Beremiz bitmaps
67c9a9482d24 Factorized bitmap and i18n resources loading in between PLCopenEditor and Beremiz. Now in utils/misc.py
Edouard Tisserant
parents: 815
diff changeset
    82
    AddBitmapFolder(os.path.join(CWD, "images"))
67c9a9482d24 Factorized bitmap and i18n resources loading in between PLCopenEditor and Beremiz. Now in utils/misc.py
Edouard Tisserant
parents: 815
diff changeset
    83
67c9a9482d24 Factorized bitmap and i18n resources loading in between PLCopenEditor and Beremiz. Now in utils/misc.py
Edouard Tisserant
parents: 815
diff changeset
    84
    # Internationalization
67c9a9482d24 Factorized bitmap and i18n resources loading in between PLCopenEditor and Beremiz. Now in utils/misc.py
Edouard Tisserant
parents: 815
diff changeset
    85
    AddCatalog(os.path.join(CWD, "locale"))