util/misc.py
author Edouard Tisserant <edouard.tisserant@gmail.com>
Sat, 17 Feb 2018 16:42:56 +0100
changeset 1942 a4382ae1ba82
parent 1930 e6de7df5f401
child 1953 5736d25bb393
permissions -rw-r--r--
Added /plcopen/InstancesPathCollector.py, to move more model xslt querying code away from PLCController.py.
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
47a3f39bead0 fix pylint warning "(relative-import) Relative import 'Y', should be 'X.Y'"
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
    30
from __future__ import absolute_import
1732
94ffe74e6895 clean-up: fix PEP8 E401 multiple imports on one line
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1719
diff changeset
    31
import os
806
abf1afc1f04d Fix bug when closing IECCodeView and IECRawCodeView, reopening them was impossible
laurent
parents: 781
diff changeset
    32
1853
47a3f39bead0 fix pylint warning "(relative-import) Relative import 'Y', should be 'X.Y'"
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
    33
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
    34
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
    35
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1735
diff changeset
    36
725
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    37
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
    38
    """ Helper func to check path write permission """
725
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    39
    if path is None or not os.path.isdir(path):
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    40
        return False
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    41
    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
    42
        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
    43
        dirs[:] = [d for d in dirs if not d[0] == '.']
704c7036db85 skip hidden files and directories on permission check
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
    44
        for name in files:
704c7036db85 skip hidden files and directories on permission check
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
    45
            if os.access(root, os.W_OK) is not True or os.access(os.path.join(root, name), os.W_OK) is not True:
704c7036db85 skip hidden files and directories on permission check
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1511
diff changeset
    46
                return False
725
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    47
    return True
31dade089db5 refactoring
Edouard Tisserant
parents:
diff changeset
    48
1923
65edbc03fdbf ClassImporter now accepts string, callable or class, for compatibility with some old extensions.
Edouard Tisserant
parents: 1920
diff changeset
    49
def GetClassImporter(param):
1920
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    50
    """
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    51
    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
    52
    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
    53
    if a class is given, then returns a callable that returns the given class.
1920
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    54
    """
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1735
diff changeset
    55
1923
65edbc03fdbf ClassImporter now accepts string, callable or class, for compatibility with some old extensions.
Edouard Tisserant
parents: 1920
diff changeset
    56
    if isinstance(param, str):
1920
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    57
        def factory():
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    58
            # 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
    59
            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
    60
            return reduce(getattr, param.split('.')[1:], mod)
1920
584ad449ee58 Documentation
Edouard Tisserant
parents: 1862
diff changeset
    61
        return factory
1930
e6de7df5f401 Removed dead code
Edouard Tisserant
parents: 1923
diff changeset
    62
    else:
1923
65edbc03fdbf ClassImporter now accepts string, callable or class, for compatibility with some old extensions.
Edouard Tisserant
parents: 1920
diff changeset
    63
        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
    64
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1735
diff changeset
    65
1388
67c9a9482d24 Factorized bitmap and i18n resources loading in between PLCopenEditor and Beremiz. Now in utils/misc.py
Edouard Tisserant
parents: 815
diff changeset
    66
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
    67
    # 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
    68
    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
    69
67c9a9482d24 Factorized bitmap and i18n resources loading in between PLCopenEditor and Beremiz. Now in utils/misc.py
Edouard Tisserant
parents: 815
diff changeset
    70
    # Internationalization
67c9a9482d24 Factorized bitmap and i18n resources loading in between PLCopenEditor and Beremiz. Now in utils/misc.py
Edouard Tisserant
parents: 815
diff changeset
    71
    AddCatalog(os.path.join(CWD, "locale"))