[PyQt] where is the documentation for pyqt5 ?

[JackDinn]

Im having a real hard time trying to learn pyqt5, i cant use http://doc.qt.io/qt-5 because its all in C++. I also see a lot of sourceforge links when searching but sourceforge has been off line for as long as i'v been trying to learn pyqt5.

I would really like to know what to set my PyCharm "External documentation" to for PyQt5? ATM iv got it set to http://doc.qt.io/qt-5/{class.name.lower}...ction.name} But its not meant for python and does not go to the correct page/command/parameter anyhow but i just guessed it at the time but would love to know what it should be set to.

My main question is where are the full python docs for all the commands in pyqt5?

[metulburr]

If the pyqt site is down then you can use the way back machine to take a look at the docs.
https://web.archive.org/web/201801101834...ocs/PyQt5/

EDIT:
fixed link

[JackDinn]

If the pyqt site is down then you can use the way back machine to take a look at the docs.
https://web.archive.org/web/201801101834...ocs/PyQt5/

EDIT:
fixed link

O yea completely forgot about the archiving sites but im not sure i can use that for my IDE but i shall try and muddle along with it, thank you.

---

Hmm well the sourceforge docs mostly just point back to http://doc.qt.io/qt-5 docs :( Yea i understand i should be able to read the info i need from there but its the examples i personally need most and trying to convert Cpp to python in my head when iv never even looked at Cpp before is a serious barrier.

Is there no proper docs for PyQt5 that i can setup my IDE with ?

[metulburr]

I dont use an IDE so i could tell you regarding that issue. I also dont code in qt so i cant say for sure about the docs pertaining to C++ references either.

The best thing i can say is if you have a problem with a specific issue or conversion from C++ to python, then post your question here. You should be able to google search an example in python using that specific feature of whatever you are searching for on the docs [CLASSNAME] python example Sure its not going to return simplified examples, but should give you a direction to point to.

[JackDinn]

well yea i can google bits and pieces scattered about or ask specific questions. I suppose I'm spoiled coming from windows using C# on VS where any class/method/argument i need info on is just a shortcut key away, it makes learning so mush smoother and easer.

However i realised im not the first person to have this kind of problem https://stackoverflow.com/questions/2099...-for-pyqt5

I think this comment summed it up

Been looking for PyQt5 tutorials for some time? Look no further! You won't find many around the internet.

[metulburr]

you can also use python docstrings

metulburr@ubuntu:~$ python3
Python 3.6.1 (default, Jun  8 2017, 06:36:16) 
[GCC 5.4.0 20160609] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import PyQt5.Qt
>>> help(PyQt5.Qt)

Hide/Show

Output:
Help on module PyQt5.Qt in PyQt5:

NAME
    PyQt5.Qt

FUNCTIONS
    QT_TRANSLATE_NOOP(...)
        QT_TRANSLATE_NOOP(str, str) -> str
    
    QT_TR_NOOP(...)
        QT_TR_NOOP(str) -> str
    
    QT_TR_NOOP_UTF8(...)
        QT_TR_NOOP_UTF8(str) -> str
    
    Q_ARG(...)
        Q_ARG(object, object) -> QGenericArgument
    
    Q_CLASSINFO(...)
        Q_CLASSINFO(str, str)
    
    Q_ENUMS(...)
        Q_ENUMS(*)
    
    Q_FLAGS(...)
        Q_FLAGS(*)
    
    Q_RETURN_ARG(...)
        Q_RETURN_ARG(object) -> QGenericReturnArgument
    
    bin_(...)
        bin_(QTextStream) -> QTextStream
    
    bom(...)
        bom(QTextStream) -> QTextStream
    
    center(...)
        center(QTextStream) -> QTextStream
    
    dec(...)
        dec(QTextStream) -> QTextStream
    
    endl(...)
        endl(QTextStream) -> QTextStream
    
    fixed(...)
        fixed(QTextStream) -> QTextStream
    
    flush(...)
        flush(QTextStream) -> QTextStream
    
    forcepoint(...)
        forcepoint(QTextStream) -> QTextStream
    
    forcesign(...)
        forcesign(QTextStream) -> QTextStream
    
    hex_(...)
        hex_(QTextStream) -> QTextStream
    left(...)
        left(QTextStream) -> QTextStream
    
    lowercasebase(...)
        lowercasebase(QTextStream) -> QTextStream
    
    lowercasedigits(...)
        lowercasedigits(QTextStream) -> QTextStream
    
    noforcepoint(...)
        noforcepoint(QTextStream) -> QTextStream
    
    noforcesign(...)
        noforcesign(QTextStream) -> QTextStream
    
    noshowbase(...)
        noshowbase(QTextStream) -> QTextStream
    
    oct_(...)
        oct_(QTextStream) -> QTextStream
    
    pyqtPickleProtocol(...)
        pyqtPickleProtocol() -> Optional[int]
    
    pyqtRemoveInputHook(...)
        pyqtRemoveInputHook()
    
    pyqtRestoreInputHook(...)
        pyqtRestoreInputHook()
    
    pyqtSetPickleProtocol(...)
        pyqtSetPickleProtocol(Optional[int])
    
    pyqtSlot(...)
        @pyqtSlot(*types, name: Optional[str], result: Optional[str])
        
        This is a decorator applied to Python methods of a QObject that marks them
        as Qt slots.
        The non-keyword arguments are the types of the slot arguments and each may
        be a Python type object or a string specifying a C++ type.
        name is the name of the slot and defaults to the name of the method.
        result is type of the value returned by the slot.
    
    qAbs(...)
        qAbs(float) -> float
    
    qAddPostRoutine(...)
        qAddPostRoutine(Callable[..., None])
    
    qAddPreRoutine(...)
        qAddPreRoutine(Callable[[], None])
    
    qAlpha(...)
        qAlpha(QRgba64) -> int
        qAlpha(int) -> int
    
    qBlue(...)
        qBlue(QRgba64) -> int
        qBlue(int) -> int
    qChecksum(...)
        qChecksum(bytes) -> int
        qChecksum(bytes, Qt.ChecksumType) -> int
    
    qCompress(...)
        qCompress(Union[QByteArray, bytes, bytearray], compressionLevel: int = -1) -> QByteArray
    
    qCritical(...)
        qCritical(str)
    
    qDebug(...)
        qDebug(str)
    
    qDrawBorderPixmap(...)
        qDrawBorderPixmap(QPainter, QRect, QMargins, QPixmap)
    
    qDrawPlainRect(...)
        qDrawPlainRect(QPainter, int, int, int, int, Union[QColor, Qt.GlobalColor], lineWidth: int = 1, fill: Union[QBrush, QColor, Qt.GlobalColor, QGradient] = None)
        qDrawPlainRect(QPainter, QRect, Union[QColor, Qt.GlobalColor, QGradient], lineWidth: int = 1, fill: Union[QBrush, QColor, Qt.GlobalColor, QGradient] = None)
    
    qDrawShadeLine(...)
        qDrawShadeLine(QPainter, int, int, int, int, QPalette, sunken: bool = True, lineWidth: int = 1, midLineWidth: int = 0)
        qDrawShadeLine(QPainter, QPoint, QPoint, QPalette, sunken: bool = True, lineWidth: int = 1, midLineWidth: int = 0)
    
    qDrawShadePanel(...)
        qDrawShadePanel(QPainter, int, int, int, int, QPalette, sunken: bool = False, lineWidth: int = 1, fill: Union[QBrush, QColor, Qt.GlobalColor, QGradient] = None)
        qDrawShadePanel(QPainter, QRect, QPalette, sunken: bool = False, lineWidth: int = 1, fill: Union[QBrush, QColor, Qt.GlobalColor, QGradient] = None)
    
    qDrawShadeRect(...)
        qDrawShadeRect(QPainter, int, int, int, int, QPalette, sunken: bool = False, lineWidth: int = 1, midLineWidth: int = 0, fill: Union[QBrush, QColor, Qt.GlobalColor, QGradient] = None)
        qDrawShadeRect(QPainter, QRect, QPalette, sunken: bool = False, lineWidth: int = 1, midLineWidth: int = 0, fill: Union[QBrush, QColor, Qt.GlobalColor, QGradient] = None)
    
    qDrawWinButton(...)
        qDrawWinButton(QPainter, int, int, int, int, QPalette, sunken: bool = False, fill: Union[QBrush, QColor, Qt.GlobalColor, QGradient] = None)
        qDrawWinButton(QPainter, QRect, QPalette, sunken: bool = False, fill: Union[QBrush, QColor, Qt.GlobalColor, QGradient] = None)
    
    qDrawWinPanel(...)
        qDrawWinPanel(QPainter, int, int, int, int, QPalette, sunken: bool = False, fill: Union[QBrush, QColor, Qt.GlobalColor, QGradient] = None)
        qDrawWinPanel(QPainter, QRect, QPalette, sunken: bool = False, fill: Union[QBrush, QColor, Qt.GlobalColor, QGradient] = None)
    
    qEnvironmentVariable(...)
        qEnvironmentVariable(str) -> str
        qEnvironmentVariable(str, str) -> str
    
    qErrnoWarning(...)
        qErrnoWarning(int, str)
        qErrnoWarning(str)
    qFatal(...)
        qFatal(str)
    
    qFloatDistance(...)
        qFloatDistance(float, float) -> int
    
    qFormatLogMessage(...)
        qFormatLogMessage(QtMsgType, QMessageLogContext, str) -> str
    
    qFuzzyCompare(...)
        qFuzzyCompare(float, float) -> bool
    
    qGray(...)
        qGray(int, int, int) -> int
        qGray(int) -> int
    
    qGreen(...)
        qGreen(QRgba64) -> int
        qGreen(int) -> int
    
    qInf(...)
        qInf() -> float
    
    qInstallMessageHandler(...)
        qInstallMessageHandler(Optional[Callable[[], None]]) -> Optional[Callable[[], None]]
    
    qIsFinite(...)
        qIsFinite(float) -> bool
    
    qIsGray(...)
        qIsGray(int) -> bool
    
    qIsInf(...)
        qIsInf(float) -> bool
    
    qIsNaN(...)
        qIsNaN(float) -> bool
    
    qIsNull(...)
        qIsNull(float) -> bool
    
    qPixelFormatAlpha(...)
        qPixelFormatAlpha(int, typeInterpretation: QPixelFormat.TypeInterpretation = QPixelFormat.UnsignedInteger) -> QPixelFormat
    
    qPixelFormatCmyk(...)
        qPixelFormatCmyk(int, alphaSize: int = 0, alphaUsage: QPixelFormat.AlphaUsage = QPixelFormat.IgnoresAlpha, alphaPosition: QPixelFormat.AlphaPosition = QPixelFormat.AtBeginning, typeInterpretation: QPixelFormat.TypeInterpretation = QPixelFormat.UnsignedInteger) -> QPixelFormat
    
    qPixelFormatGrayscale(...)
        qPixelFormatGrayscale(int, typeInterpretation: QPixelFormat.TypeInterpretation = QPixelFormat.UnsignedInteger) -> QPixelFormat
    
    qPixelFormatHsl(...)
        qPixelFormatHsl(int, alphaSize: int = 0, alphaUsage: QPixelFormat.AlphaUsage = QPixelFormat.IgnoresAlpha, alphaPosition: QPixelFormat.AlphaPosition = QPixelFormat.AtBeginning, typeInterpretation: QPixelFormat.TypeInterpretation = QPixelFormat.FloatingPoint) -> QPixelFormat
    qPixelFormatHsv(...)
        qPixelFormatHsv(int, alphaSize: int = 0, alphaUsage: QPixelFormat.AlphaUsage = QPixelFormat.IgnoresAlpha, alphaPosition: QPixelFormat.AlphaPosition = QPixelFormat.AtBeginning, typeInterpretation: QPixelFormat.TypeInterpretation = QPixelFormat.FloatingPoint) -> QPixelFormat
    
    qPixelFormatRgba(...)
        qPixelFormatRgba(int, int, int, int, QPixelFormat.AlphaUsage, QPixelFormat.AlphaPosition, premultiplied: QPixelFormat.AlphaPremultiplied = QPixelFormat.NotPremultiplied, typeInterpretation: QPixelFormat.TypeInterpretation = QPixelFormat.UnsignedInteger) -> QPixelFormat
    
    qPixelFormatYuv(...)
        qPixelFormatYuv(QPixelFormat.YUVLayout, alphaSize: int = 0, alphaUsage: QPixelFormat.AlphaUsage = QPixelFormat.IgnoresAlpha, alphaPosition: QPixelFormat.AlphaPosition = QPixelFormat.AtBeginning, premultiplied: QPixelFormat.AlphaPremultiplied = QPixelFormat.NotPremultiplied, typeInterpretation: QPixelFormat.TypeInterpretation = QPixelFormat.UnsignedByte, byteOrder: QPixelFormat.ByteOrder = QPixelFormat.LittleEndian) -> QPixelFormat
    
    qPremultiply(...)
        qPremultiply(QRgba64) -> QRgba64
        qPremultiply(int) -> int
    
    qQNaN(...)
        qQNaN() -> float
    
    qRed(...)
        qRed(QRgba64) -> int
        qRed(int) -> int
    
    qRegisterResourceData(...)
        qRegisterResourceData(int, bytes, bytes, bytes) -> bool
    
    qRemovePostRoutine(...)
        qRemovePostRoutine(Callable[..., None])
    
    qRgb(...)
        qRgb(int, int, int) -> int
    
    qRgba(...)
        qRgba(int, int, int, int) -> int
    
    qRgba64(...)
        qRgba64(int, int, int, int) -> QRgba64
        qRgba64(int) -> QRgba64
    
    qRound(...)
        qRound(float) -> int
    
    qRound64(...)
        qRound64(float) -> int
    
    qSNaN(...)
        qSNaN() -> float
    
    qSetFieldWidth(...)
       qSetFieldWidth(int) -> QTextStreamManipulator
    
    qSetMessagePattern(...)
        qSetMessagePattern(str)
    
    qSetPadChar(...)
        qSetPadChar(str) -> QTextStreamManipulator
    
    qSetRealNumberPrecision(...)
        qSetRealNumberPrecision(int) -> QTextStreamManipulator
    
    qSharedBuild(...)
        qSharedBuild() -> bool
    
    qUncompress(...)
        qUncompress(Union[QByteArray, bytes, bytearray]) -> QByteArray
    
    qUnpremultiply(...)
        qUnpremultiply(QRgba64) -> QRgba64
        qUnpremultiply(int) -> int
    
    qUnregisterResourceData(...)
        qUnregisterResourceData(int, bytes, bytes, bytes) -> bool
    
    qVersion(...)
        qVersion() -> str
    
    qWarning(...)
        qWarning(str)
    
    qjsEngine(...)
        qjsEngine(QObject) -> QJSEngine
    
    qmlAttachedPropertiesObject(...)
        qmlAttachedPropertiesObject(type, QObject, create: bool = True) -> QObject
    
    qmlClearTypeRegistrations(...)
        qmlClearTypeRegistrations()
    
    qmlRegisterRevision(...)
        qmlRegisterRevision(type, int, str, int, int, attachedProperties: type = 0) -> int
    
    qmlRegisterSingletonType(...)
        qmlRegisterSingletonType(QUrl, str, int, int, str) -> int
        qmlRegisterSingletonType(type, str, int, int, str, Callable[[], Any]) -> int
    
    qmlRegisterType(...)
        qmlRegisterType(QUrl, str, int, int, str) -> int
        qmlRegisterType(type, attachedProperties: type = 0) -> int
        qmlRegisterType(type, str, int, int, str, attachedProperties: type = 0) -> int
        qmlRegisterType(type, int, str, int, int, str, attachedProperties: type = 0) -> int
    
    qmlRegisterUncreatableType(...)
        qmlRegisterUncreatableType(type, str, int, int, str, str) -> int
        qmlRegisterUncreatableType(type, int, str, int, int, str, str) -> int
    
    qrand(...)
        qrand() -> int
    
    qsrand(...)
        qsrand(int)
    
    qt_set_sequence_auto_mnemonic(...)
        qt_set_sequence_auto_mnemonic(bool)
    
    reset(...)
        reset(QTextStream) -> QTextStream
    
    right(...)
        right(QTextStream) -> QTextStream
    
    scientific(...)
        scientific(QTextStream) -> QTextStream
    
    showbase(...)
        showbase(QTextStream) -> QTextStream
    
    uppercasebase(...)
        uppercasebase(QTextStream) -> QTextStream
    
    uppercasedigits(...)
        uppercasedigits(QTextStream) -> QTextStream
    
    ws(...)
        ws(QTextStream) -> QTextStream

DATA
    PYQT_CONFIGURATION = {'sip_flags': '-t WS_X11 -t Qt_5_10_1'}
    PYQT_VERSION = 330241
    PYQT_VERSION_STR = '5.10.1'
    QQmlListProperty = 'QQmlListProperty<QObject>'
    QT_VERSION = 330241
    QT_VERSION_STR = '5.10.1'
    QWIDGETSIZE_MAX = 16777215
    QtCriticalMsg = 2
    QtDebugMsg = 0
    QtFatalMsg = 3
    QtInfoMsg = 4
    QtSystemMsg = 2
    QtWarningMsg = 1
    __license__ = mappingproxy({'Type': 'gpl'})
    qApp = <PyQt5.QtWidgets.QApplication object>

FILE
    /usr/local/lib/python3.6/site-packages/PyQt5/Qt.so

as well as limit it to method

>>> help(PyQt5.Qt.qrand)

Output:
Help on built-in function qrand in module PyQt5.QtCore:

qrand(...)
    qrand() -> int

Though they do not give full blown examples they give what arguments expected and what it returns, and constants.

EDIT:
Just thought of something....you can also use nullege
http://nullege.com/codes/search/PyQt5.QtCore.qrand

[JackDinn]

Thank you for your last message , i would have replied sooner but had no idea you responded because i got no notification email for your last post (first 2 i did). That last link looks like it will be very helpful as i can integrate that into the PyCharm external help settings.

Thank you.

[Larz60+]

http://pyqt.sourceforge.net/Docs/PyQt5/ is back up!

[JackDinn]

Cool, Thx for the "heads up".

No notification email again! (checked all site settings, i am subscribed to this thread with instant mail notification, checked junk/spam, nothing changed since first 2 posts when i did get the emails) , 1 step forward 2 steps back :(

[metulburr]

the email system appears to be working from my end. We are using STMP so might just be a glitch...it does do that from time to time.